Documentation
¶
Index ¶
- type ACSubjectInfo
- type ACUserIdentity
- type ALBServicesAccount
- type ALBServicesAccountUser
- type ALBServicesCase
- type ALBServicesCaseAttachment
- type ALBServicesConfig
- type ALBServicesConfigAPIResponse
- type ALBServicesFileUpload
- type ALBServicesFileUploadAPIResponse
- type ALBServicesStatusDetails
- type ALBServicesUser
- type APICConfiguration
- type APICLifsRuntime
- type APICLifsRuntimeAPIResponse
- type APICNetworkRel
- type APIVersionDeprecated
- type AWSASGDelete
- type AWSASGNotifDetails
- type AWSLogin
- type AWSSetup
- type AbPool
- type ActionGroupConfig
- type ActionGroupConfigAPIResponse
- type AdminAuthConfiguration
- type Alert
- type AlertAPIResponse
- type AlertConfig
- type AlertConfigAPIResponse
- type AlertEmailConfig
- type AlertEmailConfigAPIResponse
- type AlertFilter
- type AlertMetricThreshold
- type AlertMgrDebugFilter
- type AlertObjectList
- type AlertObjectListAPIResponse
- type AlertRule
- type AlertRuleEvent
- type AlertRuleMetric
- type AlertScriptConfig
- type AlertScriptConfigAPIResponse
- type AlertSyslogConfig
- type AlertSyslogConfigAPIResponse
- type AlertSyslogServer
- type AlertTestEmailParams
- type AlertTestSyslogSnmpParams
- type AllSeUpgradeEventDetails
- type AnalyticsPolicy
- type AnalyticsProfile
- type AnalyticsProfileAPIResponse
- type AnomalyEventDetails
- type ApicAgentBridgeDomainVrfChange
- type ApicAgentGenericEventDetails
- type ApicAgentVsNetworkError
- type ApicVSPlacementReq
- type AppCookiePersistenceProfile
- type AppHdr
- type AppInfo
- type AppLearningConfidenceOverride
- type AppLearningParams
- type AppSignatureConfig
- type AppSignatureEventData
- type Application
- type ApplicationAPIResponse
- type ApplicationLog
- type ApplicationPersistenceProfile
- type ApplicationPersistenceProfileAPIResponse
- type ApplicationProfile
- type ApplicationProfileAPIResponse
- type ArpTableFilter
- type AttackMetaData
- type AttackMetaDataAPIResponse
- type AttackMitigationAction
- type AuditComplianceEventInfo
- type AuthAttributeMatch
- type AuthMappingRule
- type AuthMatchAttribute
- type AuthMatchGroupMembership
- type AuthProfile
- type AuthProfileAPIResponse
- type AuthProfileHTTPClientParams
- type AuthTacacsPlusAttributeValuePair
- type AuthenticationAction
- type AuthenticationMatch
- type AuthenticationPolicy
- type AuthenticationRule
- type AuthnRuleMatch
- type AuthorizationAction
- type AuthorizationMatch
- type AuthorizationPolicy
- type AuthorizationRule
- type AuthzRuleMatch
- type AutoScaleLaunchConfig
- type AutoScaleLaunchConfigAPIResponse
- type AutoScaleMesosSettings
- type AutoScaleMgrDebugFilter
- type AutoScaleOpenStackSettings
- type AvailabilityZone
- type AvailabilityZoneAPIResponse
- type AvgUptimeChangeDetails
- type AwsConfiguration
- type AwsEncryption
- type AwsZoneConfig
- type AwsZoneNetwork
- type AzureClusterInfo
- type AzureConfiguration
- type AzureInfo
- type AzureMarketplace
- type AzureNetworkInfo
- type AzureServicePrincipalCredentials
- type AzureSetup
- type AzureUserPassCredentials
- type BMSetup
- type Backup
- type BackupAPIResponse
- type BackupConfiguration
- type BackupConfigurationAPIResponse
- type BfdProfile
- type BgpPeer
- type BgpProfile
- type BgpRoutingOptions
- type BotAllowList
- type BotAllowRule
- type BotClassMatcher
- type BotClassification
- type BotConfigConsolidator
- type BotConfigConsolidatorAPIResponse
- type BotConfigIPLocation
- type BotConfigIPReputation
- type BotConfigUserAgent
- type BotDetectionMatch
- type BotDetectionPolicy
- type BotDetectionPolicyAPIResponse
- type BotEvaluationResult
- type BotIdentification
- type BotManagementLog
- type BotMapping
- type BotMappingAPIResponse
- type BotMappingRule
- type BotTypeMatcher
- type BuildInfo
- type BurstLicenseDetails
- type CCAgentProperties
- type CCProperties
- type CCScaleSetNotifDetails
- type CCVnicInfo
- type CRL
- type CRSDeploymentFailure
- type CRSDeploymentSuccess
- type CRSDetails
- type CRSDetailsAPIResponse
- type CRSUpdateDetails
- type CaptureFileSize
- type CaptureFilters
- type CaptureIPC
- type CdpLldpInfo
- type CertificateAuthority
- type CertificateManagementProfile
- type CertificateManagementProfileAPIResponse
- type CfgState
- type ChildProcessInfo
- type Cif
- type ClientInsightsSampling
- type ClientLogConfiguration
- type ClientLogFilter
- type ClientLogStreamingConfig
- type ClientLogStreamingFormat
- type CloneServer
- type Cloud
- type CloudAPIResponse
- type CloudASGNotifDetails
- type CloudAutoscalingConfigFailureDetails
- type CloudClusterVip
- type CloudConnectorDebugFilter
- type CloudConnectorUser
- type CloudConnectorUserAPIResponse
- type CloudConnectorUserTestParams
- type CloudDNSUpdate
- type CloudFlavor
- type CloudGeneric
- type CloudHealth
- type CloudIPChange
- type CloudInfo
- type CloudMeta
- type CloudProperties
- type CloudPropertiesAPIResponse
- type CloudRouteNotifDetails
- type CloudRuntime
- type CloudRuntimeAPIResponse
- type CloudSeVMChange
- type CloudStackConfiguration
- type CloudStackSetup
- type CloudSyncServices
- type CloudTenantCleanup
- type CloudTenantsDeleted
- type CloudVipParkingIntf
- type CloudVipUpdate
- type CloudVnicChange
- type ClusterCloudDetails
- type ClusterCloudDetailsAPIResponse
- type ClusterConfigFailedEvent
- type ClusterLeaderFailoverEvent
- type ClusterNode
- type ClusterNodeAddEvent
- type ClusterNodeDbFailedEvent
- type ClusterNodeRemoveEvent
- type ClusterNodeShutdownEvent
- type ClusterNodeStartedEvent
- type ClusterServiceCriticalFailureEvent
- type ClusterServiceFailedEvent
- type ClusterServiceRestoredEvent
- type ClusterWarmRebootEvent
- type CompressionFilter
- type CompressionProfile
- type ConfigActionDetails
- type ConfigCreateDetails
- type ConfigDeleteDetails
- type ConfigInfo
- type ConfigSeGrpFlvUpdate
- type ConfigUpdateDetails
- type ConfigUserAuthrzByRule
- type ConfigUserLogin
- type ConfigUserLogout
- type ConfigUserNotAuthrzByRule
- type ConfigUserPasswordChangeRequest
- type ConnErrorInfo
- type ConnPoolProperties
- type ConnectionClearFilter
- type ConnectionLog
- type ConnpoolFilter
- type ContainerCloudBatchSetup
- type ContainerCloudService
- type ContainerCloudSetup
- type ContentLibConfig
- type ContentRewriteProfile
- type ControllerCloudLimits
- type ControllerDiscontinuousTimeChangeEventDetails
- type ControllerLicenseReconcileDetails
- type ControllerLimits
- type ControllerPortalAsset
- type ControllerPortalAuth
- type ControllerPortalRegistration
- type ControllerPortalRegistrationAPIResponse
- type ControllerProperties
- type ControllerPropertiesAPIResponse
- type ControllerSite
- type ControllerSiteAPIResponse
- type ControllerSize
- type ControllerSizingCloudLimits
- type ControllerSizingLimits
- type ControllerUpgradeState
- type CookieMatch
- type CustomIPAMDNSProfile
- type CustomIPAMDNSProfileAPIResponse
- type CustomParams
- type CustomTag
- type DNSAAAARdata
- type DNSARdata
- type DNSAttack
- type DNSAttacks
- type DNSClientIPMatch
- type DNSCnameRdata
- type DNSConfig
- type DNSConfiguration
- type DNSEdnsOption
- type DNSGeoLocationMatch
- type DNSInfo
- type DNSMxRdata
- type DNSNsRdata
- type DNSOptRecord
- type DNSPolicies
- type DNSPolicy
- type DNSPolicyAPIResponse
- type DNSQueryNameMatch
- type DNSQueryTypeMatch
- type DNSRateLimiter
- type DNSRateProfile
- type DNSRecord
- type DNSRegisterInfo
- type DNSRequest
- type DNSResourceRecord
- type DNSResponse
- type DNSRrSet
- type DNSRule
- type DNSRuleAction
- type DNSRuleActionAllowDrop
- type DNSRuleActionGslbSiteSelection
- type DNSRuleActionPoolSwitching
- type DNSRuleActionResponse
- type DNSRuleDNSRrSet
- type DNSRuleMatchTarget
- type DNSRuleRLAction
- type DNSServiceApplicationProfile
- type DNSServiceDomain
- type DNSSrvRdata
- type DNSTransportProtocolMatch
- type DNSTxtRdata
- type DNSVsSyncInfo
- type DNSZone
- type DSRequestLog
- type DataScriptErrorTrace
- type DatabaseEventInfo
- type DbAppLearningInfo
- type DebugController
- type DebugControllerAPIResponse
- type DebugDNSOptions
- type DebugFilterUnion
- type DebugIPAddr
- type DebugSeAgent
- type DebugSeCPUShares
- type DebugSeDataplane
- type DebugSeFault
- type DebugServiceEngine
- type DebugServiceEngineAPIResponse
- type DebugVirtualService
- type DebugVirtualServiceAPIResponse
- type DebugVirtualServiceCapture
- type DebugVirtualServiceObjSync
- type DebugVirtualServiceSeParams
- type DebugVrf
- type DebugVrfContext
- type DebugVsDataplane
- type DisableSeMigrateEventDetails
- type DiscoveredNetwork
- type DispatcherTableDumpClear
- type DockerConfiguration
- type DockerRegistry
- type DockerUCPSetup
- type DosAttackEventDetails
- type DosRateLimitProfile
- type DosThreshold
- type DosThresholdProfile
- type DsrProfile
- type DynamicDNSRecord
- type DynamicDNSRecordAPIResponse
- type EmailConfiguration
- type EquivalentLabels
- type ErrorPage
- type ErrorPageBody
- type ErrorPageBodyAPIResponse
- type ErrorPageProfile
- type ErrorPageProfileAPIResponse
- type EventCache
- type EventDetails
- type EventDetailsFilter
- type EventGenParams
- type EventLog
- type EventMap
- type FailAction
- type FailActionBackupPool
- type FailActionHTTPLocalResponse
- type FailActionHTTPRedirect
- type FeProxyRoutePublishConfig
- type FederationCheckpoint
- type FederationCheckpointAPIResponse
- type FileObject
- type FileObjectAPIResponse
- type FloatingIPSubnet
- type FlowtableProfile
- type FullClientLogs
- type GCPCloudRouterUpdate
- type GCPConfiguration
- type GCPCredentials
- type GCPEncryptionKeys
- type GCPInBandManagement
- type GCPNetworkConfig
- type GCPOneArmMode
- type GCPSeGroupConfig
- type GCPSetup
- type GCPTwoArmMode
- type GCPVIPAllocation
- type GCPVIPILB
- type GCPVIPRoutes
- type GatewayMonitor
- type GcpInfo
- type GeoDB
- type GeoDBAPIResponse
- type GeoDBFile
- type GeoDBMapping
- type GeoDBMappingElement
- type GeoLocation
- type GeoMatch
- type Gslb
- type GslbAPIResponse
- type GslbClientIPAddrGroup
- type GslbDNSGeoUpdate
- type GslbDNSGsStatus
- type GslbDNSInfo
- type GslbDNSSeInfo
- type GslbDNSUpdate
- type GslbDownloadStatus
- type GslbGeoDbEntry
- type GslbGeoDbFile
- type GslbGeoDbProfile
- type GslbGeoDbProfileAPIResponse
- type GslbGeoLocation
- type GslbHealthMonitorProxy
- type GslbIPAddr
- type GslbObj
- type GslbObjectInfo
- type GslbPerDNSState
- type GslbPool
- type GslbPoolMember
- type GslbPoolMemberDatapathStatus
- type GslbPoolMemberRuntimeInfo
- type GslbPoolRuntime
- type GslbReplicationStats
- type GslbRuntime
- type GslbService
- type GslbServiceAPIResponse
- type GslbServiceDownResponse
- type GslbServiceRuntime
- type GslbServiceSitePersistencePool
- type GslbServiceStatus
- type GslbSite
- type GslbSiteCfgSyncInfo
- type GslbSiteDNSVs
- type GslbSiteHealthStatus
- type GslbSiteRuntime
- type GslbSiteRuntimeCfg
- type GslbSiteRuntimeInfo
- type GslbSiteRuntimeStats
- type GslbStatus
- type GslbSubDomainPlacementRuntime
- type GslbThirdPartySite
- type GslbThirdPartySiteRuntime
- type HSMAwsCloudHsm
- type HSMSafenetClientInfo
- type HSMSafenetLuna
- type HSMSafenetLunaServer
- type HSMThalesNetHsm
- type HSMThalesRFS
- type HSMgrDebugFilter
- type HTTPApplicationProfile
- type HTTPCacheConfig
- type HTTPCacheObjFilter
- type HTTPClientAuthenticationParams
- type HTTPCookieData
- type HTTPCookiePersistenceKey
- type HTTPCookiePersistenceProfile
- type HTTPHdrAction
- type HTTPHdrData
- type HTTPHdrValue
- type HTTPLocalFile
- type HTTPPolicies
- type HTTPPolicySet
- type HTTPPolicySetAPIResponse
- type HTTPRedirectAction
- type HTTPRequestPolicy
- type HTTPRequestRule
- type HTTPReselectRespCode
- type HTTPResponsePolicy
- type HTTPResponseRule
- type HTTPRewriteLocHdrAction
- type HTTPRewriteURLAction
- type HTTPVersionMatch
- type HardwareSecurityModule
- type HardwareSecurityModuleGroup
- type HardwareSecurityModuleGroupAPIResponse
- type HdrMatch
- type HdrPersistenceProfile
- type HealthMonitor
- type HealthMonitorAPIResponse
- type HealthMonitorAuthInfo
- type HealthMonitorDNS
- type HealthMonitorExternal
- type HealthMonitorHTTP
- type HealthMonitorImap
- type HealthMonitorPop3
- type HealthMonitorRadius
- type HealthMonitorSIP
- type HealthMonitorSMTP
- type HealthMonitorSSlattributes
- type HealthMonitorTCP
- type HealthMonitorUDP
- type HealthScoreDetails
- type HostAttributes
- type HostHdrMatch
- type HostUnavailEventDetails
- type Http2ApplicationProfile
- type HttpsecurityAction
- type HttpsecurityActionRateProfile
- type HttpsecurityPolicy
- type HttpsecurityRule
- type HttpserverReselect
- type HttpstatusMatch
- type HttpstatusRange
- type HttpswitchingAction
- type HypervisorProperties
- type IPAMDNSAwsProfile
- type IPAMDNSAzureProfile
- type IPAMDNSCustomProfile
- type IPAMDNSGCPProfile
- type IPAMDNSInfobloxProfile
- type IPAMDNSInternalProfile
- type IPAMDNSOCIprofile
- type IPAMDNSOpenstackProfile
- type IPAMDNSProviderProfile
- type IPAMDNSProviderProfileAPIResponse
- type IPAMDNSTencentProfile
- type IPAMUsableNetwork
- type IPAddr
- type IPAddrGroup
- type IPAddrGroupAPIResponse
- type IPAddrMatch
- type IPAddrPort
- type IPAddrPrefix
- type IPAddrRange
- type IPAllocInfo
- type IPCommunity
- type IPNetworkSubnet
- type IPPersistenceProfile
- type IPReputationConfig
- type IPReputationDB
- type IPReputationDBAPIResponse
- type IPReputationServiceStatus
- type IPReputationTypeMapping
- type IPReputationTypeMatch
- type IPThreatDBEventData
- type IcapLog
- type IcapProfile
- type IcapProfileAPIResponse
- type IcapRequestLog
- type IcapViolation
- type Image
- type ImageAPIResponse
- type ImageCloudData
- type ImageCloudSpecificData
- type InfobloxSubnet
- type IngAttribute
- type InternalGatewayMonitor
- type IptableRule
- type IptableRuleSet
- type JWTClaimMatch
- type JWTMatch
- type JWTServerProfile
- type JWTServerProfileAPIResponse
- type JWTValidationVsConfig
- type JobEntry
- type JobEntryAPIResponse
- type JwtLog
- type KeyValue
- type KeyValueTuple
- type L4ConnectionPolicy
- type L4Policies
- type L4PolicySet
- type L4PolicySetAPIResponse
- type L4Rule
- type L4RuleAction
- type L4RuleActionSelectPool
- type L4RuleMatchTarget
- type L4RulePortMatch
- type L4RuleProtocolMatch
- type LdapAuthSettings
- type LdapDirectorySettings
- type LdapUserBindSettings
- type LearningLogPolicy
- type LicenseDetails
- type LicenseExpiryDetails
- type LicenseInfo
- type LicenseLedgerDetails
- type LicenseLedgerDetailsAPIResponse
- type LicenseTierSwitchDetiails
- type LicenseTierUsage
- type LicenseTransactionDetails
- type LicenseUsage
- type Lif
- type LinuxConfiguration
- type LinuxServerConfiguration
- type LinuxServerHost
- type LocationHdrMatch
- type LogAgentEventDetail
- type LogAgentTCPClientEventDetail
- type LogControllerMapping
- type LogControllerMappingAPIResponse
- type MarathonConfiguration
- type MarathonSeDeployment
- type MarathonServicePortConflict
- type MatchReplacePair
- type MatchTarget
- type MemberInterface
- type MemoryBalancerInfo
- type MesosAttribute
- type MesosConfiguration
- type MesosMetricsDebugFilter
- type MesosSeResources
- type MesosSetup
- type MethodMatch
- type MetricLog
- type MetricStatistics
- type MetricThresoldUpDetails
- type MetricsAPISrvDebugFilter
- type MetricsData
- type MetricsDataHeader
- type MetricsDataSeries
- type MetricsDbDiskEventDetails
- type MetricsDbQueueFullEventDetails
- type MetricsDbQueueHealthyEventDetails
- type MetricsDbRuntime
- type MetricsDerivationData
- type MetricsDimensionData
- type MetricsEventThreshold
- type MetricsMgrDebugFilter
- type MetricsMissingDataInterval
- type MetricsQueryResponse
- type MetricsRealTimeUpdate
- type MgmtIPAccessControl
- type MicroService
- type MicroServiceAPIResponse
- type MicroServiceContainer
- type MicroServiceGroup
- type MicroServiceGroupAPIResponse
- type MicroServiceMatch
- type NTPAuthenticationKey
- type NTPConfiguration
- type NTPServer
- type NatAddrInfo
- type NatMatchTarget
- type NatPolicy
- type NatPolicyAPIResponse
- type NatPolicyAction
- type NatRule
- type Network
- type NetworkAPIResponse
- type NetworkFilter
- type NetworkProfile
- type NetworkProfileAPIResponse
- type NetworkProfileUnion
- type NetworkRuntime
- type NetworkRuntimeAPIResponse
- type NetworkSecurityMatchTarget
- type NetworkSecurityPolicy
- type NetworkSecurityPolicyAPIResponse
- type NetworkSecurityPolicyActionRLParam
- type NetworkSecurityRule
- type NetworkService
- type NetworkServiceAPIResponse
- type NetworkSubnetClash
- type NetworkSubnetInfo
- type NsxConfiguration
- type NsxtConfiguration
- type NsxtCredentials
- type NsxtDatastores
- type NsxtHosts
- type NsxtImageDetails
- type NsxtSegmentRuntime
- type NsxtSegmentRuntimeAPIResponse
- type NsxtSetup
- type NsxtTier1SegmentAutomaticMode
- type NsxtTier1SegmentConfig
- type NsxtTier1SegmentManualMode
- type NtlmLog
- type NuageSDNController
- type OCICredentials
- type OCISetup
- type OCSPConfig
- type OCSPResponseInfo
- type OShiftK8SConfiguration
- type ObjSyncConfig
- type OpenStackAPIVersionCheckFailure
- type OpenStackClusterSetup
- type OpenStackConfiguration
- type OpenStackHypervisorProperties
- type OpenStackIPChange
- type OpenStackLbPluginOp
- type OpenStackLbProvAuditCheck
- type OpenStackRoleMapping
- type OpenStackSeVMChange
- type OpenStackSyncServices
- type OpenStackVipNetwork
- type OpenStackVnicChange
- type OpenstackLogin
- type OperationalStatus
- type OpsHistory
- type OshiftDockerRegistryMetaData
- type OshiftSharedVirtualService
- type OutOfBandRequestLog
- type PGDeploymentRule
- type PGDeploymentRuleResult
- type PKIprofile
- type PKIprofileAPIResponse
- type PaaLog
- type PaaRequestLog
- type PackageDetails
- type ParamInfo
- type ParamSizeClass
- type ParamTypeClass
- type PatchData
- type PatchInfo
- type PathMatch
- type PerformanceLimits
- type Permission
- type PersistenceFilter
- type PingAccessAgent
- type PingAccessAgentAPIResponse
- type PlacementNetwork
- type PlacementScopeConfig
- type PodToleration
- type Pool
- type PoolAPIResponse
- type PoolAnalyticsPolicy
- type PoolDeploymentFailureInfo
- type PoolDeploymentSuccessInfo
- type PoolDeploymentUpdateInfo
- type PoolGroup
- type PoolGroupAPIResponse
- type PoolGroupDeploymentPolicy
- type PoolGroupDeploymentPolicyAPIResponse
- type PoolGroupMember
- type PoolServer
- type PortMatch
- type PortMatchGeneric
- type PortRange
- type PortalConfiguration
- type PortalFeatureOptIn
- type PriorityLabels
- type PriorityLabelsAPIResponse
- type ProactiveSupportDefaults
- type Property
- type ProtocolMatch
- type ProtocolParser
- type ProtocolParserAPIResponse
- type ProxyConfiguration
- type PsmProgramDetails
- type QueryMatch
- type RancherConfiguration
- type RateLimiter
- type RateLimiterAction
- type RateLimiterEventDetails
- type RateLimiterProfile
- type RateLimiterProperties
- type RateProfile
- type RebalanceMigrateEventDetails
- type RebalanceScaleinEventDetails
- type RebalanceScaleoutEventDetails
- type RebootData
- type RediscoverVcenterParam
- type ReplaceStringVar
- type ReplicationPolicy
- type ResponseMatchTarget
- type RetryPlacementParams
- type RmAddNetworksEventDetails
- type RmAddVnic
- type RmBindVsSeEventDetails
- type RmDeleteSeEventDetails
- type RmModifyNetworksEventDetails
- type RmModifyVnic
- type RmRebootSeEventDetails
- type RmSeBootupFailEventDetails
- type RmSeIPFailEventDetails
- type RmSpawnSeEventDetails
- type RmUnbindVsSeEventDetails
- type Role
- type RoleAPIResponse
- type RoleFilter
- type RoleFilterMatchLabel
- type RouteInfo
- type RoutingService
- type SAMLSPConfig
- type SCPoolServerStateInfo
- type SCPoolServerStateInfoAPIResponse
- type SCServerStateInfo
- type SCVsStateInfo
- type SCVsStateInfoAPIResponse
- type SEFaultInjectExhaustParam
- type SEFaultInjectSeParam
- type SSHSeDeployment
- type SSLCacheFilter
- type SSLCertificate
- type SSLCertificateDescription
- type SSLCipherList
- type SSLClientCertificateAction
- type SSLClientRequestHeader
- type SSLExpireDetails
- type SSLExportDetails
- type SSLIgnoredDetails
- type SSLKeyAndCertificate
- type SSLKeyAndCertificateAPIResponse
- type SSLKeyECParams
- type SSLKeyParams
- type SSLKeyRSAParams
- type SSLProfile
- type SSLProfileAPIResponse
- type SSLProfileSelector
- type SSLRating
- type SSLRenewDetails
- type SSLRenewFailedDetails
- type SSLRevokedDetails
- type SSLVersion
- type SSOPolicy
- type SSOPolicyAPIResponse
- type SamlAttribute
- type SamlAuthnRuleMatch
- type SamlAuthzRuleMatch
- type SamlIdentityProviderSettings
- type SamlLog
- type SamlServiceProviderNode
- type SamlServiceProviderSettings
- type SamlSettings
- type ScaleStatus
- type Scheduler
- type SchedulerAPIResponse
- type SchedulerActionDetails
- type SeAgentProperties
- type SeAgentStateCacheProperties
- type SeBgpPeerDownDetails
- type SeBgpPeerStateChangeDetails
- type SeBootupCompressionProperties
- type SeBootupProperties
- type SeDiscontinuousTimeChangeEventDetails
- type SeDupipEventDetails
- type SeFault
- type SeGatewayHeartbeatFailedDetails
- type SeGatewayHeartbeatSuccessDetails
- type SeGeoDbDetails
- type SeGroupAnalyticsPolicy
- type SeGroupOptions
- type SeGroupResumeOptions
- type SeGroupStatus
- type SeHBEventDetails
- type SeHbRecoveredEventDetails
- type SeHmEventGSDetails
- type SeHmEventGslbPoolDetails
- type SeHmEventGslbPoolMemberDetails
- type SeHmEventPoolDetails
- type SeHmEventServerDetails
- type SeHmEventShmDetails
- type SeHmEventVsDetails
- type SeIPAddedEventDetails
- type SeIPRemovedEventDetails
- type SeIp6DadFailedEventDetails
- type SeIpfailureEventDetails
- type SeLicensedBandwdithExceededEventDetails
- type SeList
- type SeMemoryLimitEventDetails
- type SeMgrDebugFilter
- type SeMgrEventDetails
- type SeMigrateEventDetails
- type SePersistenceEventDetails
- type SePoolLbEventDetails
- type SeProperties
- type SePropertiesAPIResponse
- type SeRPCProxyDebugFilter
- type SeRateLimiters
- type SeReconcileDetails
- type SeResources
- type SeRuntimeCompressionProperties
- type SeRuntimeProperties
- type SeThreshEventDetails
- type SeUpgradeEventDetails
- type SeUpgradeEvents
- type SeUpgradeMigrateEventDetails
- type SeUpgradeParams
- type SeUpgradeScaleinEventDetails
- type SeUpgradeScaleoutEventDetails
- type SeUpgradeStatusSummary
- type SeUpgradeVsDisruptedEventDetails
- type SeVersionCheckFailedEvent
- type SeVipInterfaceList
- type SeVnicDownEventDetails
- type SeVnicTxQueueStallEventDetails
- type SeVnicUpEventDetails
- type SeVsFaultEventDetails
- type SeVsPktBufHighEventDetails
- type SecMgrDataEvent
- type SecMgrThreshold
- type SecureChannelAvailableLocalIps
- type SecureChannelAvailableLocalIpsAPIResponse
- type SecureChannelConfiguration
- type SecureChannelMapping
- type SecureChannelMappingAPIResponse
- type SecureChannelMetadata
- type SecureChannelToken
- type SecureChannelTokenAPIResponse
- type SecureKeyExchangeDetails
- type SecurityManagerData
- type SecurityManagerDataAPIResponse
- type SecurityMgrDebugFilter
- type SecurityMgrRuntime
- type SecurityPolicy
- type SecurityPolicyAPIResponse
- type Selector
- type SensitiveFieldRule
- type SensitiveLogProfile
- type Server
- type ServerAutoScaleFailedInfo
- type ServerAutoScaleInCompleteInfo
- type ServerAutoScaleInInfo
- type ServerAutoScaleOutCompleteInfo
- type ServerAutoScaleOutInfo
- type ServerAutoScalePolicy
- type ServerAutoScalePolicyAPIResponse
- type ServerConfig
- type ServerID
- type ServerScaleInParams
- type ServerScaleOutParams
- type Service
- type ServiceEngine
- type ServiceEngineAPIResponse
- type ServiceEngineCloudLimits
- type ServiceEngineGroup
- type ServiceEngineGroupAPIResponse
- type ServiceEngineLimits
- type ServiceMatch
- type ServicePoolSelector
- type SidebandProfile
- type SipLog
- type SipMessage
- type SipServiceApplicationProfile
- type SiteVersion
- type SiteVersionAPIResponse
- type SnmpConfiguration
- type SnmpTrapProfile
- type SnmpTrapProfileAPIResponse
- type SnmpTrapServer
- type SnmpV3Configuration
- type SnmpV3UserParams
- type StateCacheMgrDebugFilter
- type StaticIPAllocInfo
- type StaticIPRange
- type StaticIPRangeRuntime
- type StaticRoute
- type StreamingSyslogConfig
- type StringGroup
- type StringGroupAPIResponse
- type StringMatch
- type SubJob
- type Subnet
- type SubnetRuntime
- type SummarizedInfo
- type SummarizedSubnetInfo
- type SupportedMigrations
- type SwitchoverEventDetails
- type SwitchoverFailEventDetails
- type SysTestEmailParams
- type SystemConfiguration
- type SystemConfigurationAPIResponse
- type SystemLimits
- type SystemLimitsAPIResponse
- type SystemUpgradeDetails
- type SystemUpgradeState
- type TCPApplicationProfile
- type TCPAttacks
- type TCPFastPathProfile
- type TCPProxyProfile
- type TLSTicket
- type TacacsPlusAuthSettings
- type Tag
- type Tenant
- type TenantAPIResponse
- type TenantConfiguration
- type TenantLabel
- type TencentCredentials
- type TencentSetup
- type TencentZoneNetwork
- type TestSeDatastoreLevel1
- type TestSeDatastoreLevel1APIResponse
- type TestSeDatastoreLevel2
- type TestSeDatastoreLevel2APIResponse
- type TestSeDatastoreLevel3
- type TestSeDatastoreLevel3APIResponse
- type Tier1LogicalRouterInfo
- type TimeStamp
- type TrafficCloneProfile
- type TrafficCloneProfileAPIResponse
- type UDPAttacks
- type UDPFastPathProfile
- type UDPProxyProfile
- type URIInfo
- type URIParam
- type URIParamQuery
- type URIParamToken
- type UpgradeEvent
- type UpgradeOpsEntry
- type UpgradeOpsParam
- type UpgradeOpsState
- type UpgradeStatusInfo
- type UpgradeStatusInfoAPIResponse
- type UpgradeStatusSummary
- type UpgradeStatusSummaryAPIResponse
- type UpgradeTask
- type User
- type UserAPIResponse
- type UserAccountProfile
- type UserAccountProfileAPIResponse
- type UserActivity
- type UserActivityAPIResponse
- type UserRole
- type VCASetup
- type VCenterConfiguration
- type VCenterCredentials
- type VCenterServer
- type VCenterServerAPIResponse
- type VCloudAirConfiguration
- type VHMatch
- type VIAdminCredentials
- type VIControllerVnicInfo
- type VICreateSEReq
- type VIDCInfo
- type VIDCInfoAPIResponse
- type VIFaultInjection
- type VIGuestvNicIPAddr
- type VIMgrClusterRuntime
- type VIMgrClusterRuntimeAPIResponse
- type VIMgrControllerRuntime
- type VIMgrControllerRuntimeAPIResponse
- type VIMgrDCRuntime
- type VIMgrDCRuntimeAPIResponse
- type VIMgrGuestNicRuntime
- type VIMgrHostRuntime
- type VIMgrHostRuntimeAPIResponse
- type VIMgrIPSubnetRuntime
- type VIMgrInterestedEntity
- type VIMgrNWRuntime
- type VIMgrNWRuntimeAPIResponse
- type VIMgrSEVMRuntime
- type VIMgrSEVMRuntimeAPIResponse
- type VIMgrVMRuntime
- type VIMgrVMRuntimeAPIResponse
- type VIMgrVcenterRuntime
- type VIMgrVcenterRuntimeAPIResponse
- type VIPGNameInfo
- type VIPGNameInfoAPIResponse
- type VIRetrievePGNames
- type VISeVMIPConfParams
- type VISeVMOvaParams
- type VISetMgmtIPSEReq
- type VISetvNicNwReq
- type VIVMVnicInfo
- type VIdeleteNetworkFilter
- type VIdeleteSEReq
- type VNIC
- type VNICNetwork
- type VSDataScript
- type VSDataScriptSet
- type VSDataScriptSetAPIResponse
- type VSDataScripts
- type VcenterCloudStatusReq
- type VcenterClusters
- type VcenterDatastore
- type VcenterHosts
- type VcenterInventoryDiagReq
- type VcenterLogin
- type VersionInfo
- type VinfraCntlrHostUnreachableList
- type VinfraDiscSummaryDetails
- type VinfraMgmtNwChangeDetails
- type VinfraPoolServerDeleteDetails
- type VinfraVMDetails
- type VinfraVcenterBadCredentials
- type VinfraVcenterConnectivityStatus
- type VinfraVcenterDiscoveryFailure
- type VinfraVcenterNetworkLimit
- type VinfraVcenterObjDeleteDetails
- type Vip
- type VipAutoscaleConfiguration
- type VipAutoscaleGroup
- type VipAutoscalePolicy
- type VipAutoscaleZones
- type VipPlacementNetwork
- type VipPlacementResolutionInfo
- type VipRuntime
- type VipScaleDetails
- type VipSeAssigned
- type VirtualService
- type VirtualServiceAPIResponse
- type VirtualServiceResource
- type VirtualServiceRuntime
- type VlanInterface
- type VlanRange
- type VrfContext
- type VrfContextAPIResponse
- type VsApicExtension
- type VsAwaitingSeEventDetails
- type VsDebugFilter
- type VsError
- type VsErrorEventDetails
- type VsEvStatus
- type VsFsmEventDetails
- type VsInitialPlacementEventDetails
- type VsMigrateEventDetails
- type VsMigrateParams
- type VsPoolNwFilterEventDetails
- type VsResyncParams
- type VsScaleInEventDetails
- type VsScaleOutEventDetails
- type VsScaleinParams
- type VsScaleoutParams
- type VsSeVnic
- type VsSwitchoverParams
- type VsVip
- type VsVipAPIResponse
- type VserverL4MetricsObj
- type VserverL7MetricsObj
- type VssPlacement
- type WafAllowlistLog
- type WafApplicationSignatureAppVersion
- type WafApplicationSignatureProvider
- type WafApplicationSignatureProviderAPIResponse
- type WafApplicationSignatures
- type WafCRS
- type WafCRSAPIResponse
- type WafConfig
- type WafDataFile
- type WafExcludeListEntry
- type WafExclusionType
- type WafLearning
- type WafLog
- type WafPSMLocation
- type WafPSMLocationMatch
- type WafPSMLog
- type WafPSMMatchElement
- type WafPSMRule
- type WafPolicy
- type WafPolicyAPIResponse
- type WafPolicyAllowlist
- type WafPolicyAllowlistRule
- type WafPolicyPSMGroup
- type WafPolicyPSMGroupAPIResponse
- type WafPolicyWhitelist
- type WafPolicyWhitelistRule
- type WafPositiveSecurityModel
- type WafProfile
- type WafProfileAPIResponse
- type WafRule
- type WafRuleGroup
- type WafRuleLog
- type WafRuleMatchData
- type WafWhitelistLog
- type WebApplicationSignatureServiceStatus
- type Webhook
- type WebhookAPIResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ACSubjectInfo ¶
type ACSubjectInfo struct { // Subject type for the audit event (e.g. DNS Hostname, IP address, URI). Field introduced in 20.1.3. // Required: true Type *string `json:"type"` // Subject value for the audit event (e.g. www.example.com, 10.10.10.10, www.foo.com/index.html). Field introduced in 20.1.3. // Required: true Value *string `json:"value"` }
ACSubjectInfo a c subject info swagger:model ACSubjectInfo
type ACUserIdentity ¶
type ACUserIdentity struct { // User identity type for audit event (e.g. username, organization, component). Field introduced in 20.1.3. // Required: true Type *string `json:"type"` // User identity value for audit event (e.g. SomeCompany, Jane Doe, Secure-shell). Field introduced in 20.1.3. // Required: true Value *string `json:"value"` }
ACUserIdentity a c user identity swagger:model ACUserIdentity
type ALBServicesAccount ¶
type ALBServicesAccount struct { // ID of an Account in the customer portal. Field introduced in 20.1.1. ID *string `json:"id,omitempty"` // Account to which the customer portal user belongs. Field introduced in 20.1.1. Name *string `json:"name,omitempty"` // Information about users within the account in the customer portal. Field introduced in 20.1.1. Users []*ALBServicesAccountUser `json:"users,omitempty"` }
ALBServicesAccount a l b services account swagger:model ALBServicesAccount
type ALBServicesAccountUser ¶
type ALBServicesAccountUser struct { // Field introduced in 20.1.1. // Required: true Email *string `json:"email"` // Field introduced in 20.1.1. // Required: true Name *string `json:"name"` // Field introduced in 20.1.1. // Required: true Phone *string `json:"phone"` }
ALBServicesAccountUser a l b services account user swagger:model ALBServicesAccountUser
type ALBServicesCase ¶
type ALBServicesCase struct { // Field introduced in 18.2.6. AssetID *string `json:"asset_id,omitempty"` // Field introduced in 18.2.6. CaseAttachments []*ALBServicesCaseAttachment `json:"case_attachments,omitempty"` // Field introduced in 18.2.6. CaseCreatedBy *string `json:"case_created_by,omitempty"` // Field introduced in 18.2.6. CaseNumber *string `json:"case_number,omitempty"` // Field introduced in 18.2.6. CaseStatus *string `json:"case_status,omitempty"` // Contact information associated to particular case. Field introduced in 20.1.1. ContactInfo *ALBServicesUser `json:"contact_info,omitempty"` // Field introduced in 18.2.6. CreatedDate *string `json:"created_date,omitempty"` // Field introduced in 18.2.6. CustomTag *string `json:"custom_tag,omitempty"` // Field introduced in 18.2.6. DeploymentEnvironment *string `json:"deployment_environment,omitempty"` // Field introduced in 18.2.6. Description *string `json:"description,omitempty"` // Email of the point of contact for a particular support case. Field introduced in 20.1.1. Email *string `json:"email,omitempty"` // Field introduced in 18.2.6. Environment *string `json:"environment,omitempty"` // Business justification for a feature request. Field introduced in 20.1.1. FrBusinessJustification *string `json:"fr_business_justification,omitempty"` // Current solution/workaround for a feature request. Field introduced in 20.1.1. FrCurrentSolution *string `json:"fr_current_solution,omitempty"` // Expected date of delivery for a feature request in YYYY-MM-DD format. Field introduced in 20.1.1. FrTiming *string `json:"fr_timing,omitempty"` // Possible use cases for a feature request. Field introduced in 20.1.1. FrUseCases *string `json:"fr_use_cases,omitempty"` // Field introduced in 18.2.6. ID *string `json:"id,omitempty"` // Field introduced in 18.2.6. LastModifiedDate *string `json:"last_modified_date,omitempty"` // Field introduced in 18.2.6. PatchVersion *string `json:"patch_version,omitempty"` // Field introduced in 18.2.6. Severity *string `json:"severity,omitempty"` // Field introduced in 18.2.6. Status *string `json:"status,omitempty"` // Field introduced in 18.2.6. Subject *string `json:"subject,omitempty"` // Field introduced in 18.2.6. Time *string `json:"time,omitempty"` // Field introduced in 18.2.6. Type *string `json:"type,omitempty"` // Field introduced in 18.2.6. Version *string `json:"version,omitempty"` }
ALBServicesCase a l b services case swagger:model ALBServicesCase
type ALBServicesCaseAttachment ¶
type ALBServicesCaseAttachment struct { // Field introduced in 18.2.6. // Required: true AttachmentName *string `json:"attachment_name"` // Field introduced in 18.2.6. // Required: true AttachmentSize *string `json:"attachment_size"` // Field introduced in 18.2.6. // Required: true AttachmentURL *string `json:"attachment_url"` }
ALBServicesCaseAttachment a l b services case attachment swagger:model ALBServicesCaseAttachment
type ALBServicesConfig ¶
type ALBServicesConfig struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Default values to be used for Application Signature sync. Field introduced in 20.1.4. Allowed in Basic edition, Essentials edition, Enterprise edition. // Required: true AppSignatureConfig *AppSignatureConfig `json:"app_signature_config"` // Information about the default contact for this controller cluster. Field introduced in 20.1.1. AssetContact *ALBServicesUser `json:"asset_contact,omitempty"` // Information about the portal features opted in for controller. Field introduced in 20.1.1. // Required: true FeatureOptInStatus *PortalFeatureOptIn `json:"feature_opt_in_status"` // Default values to be used for IP Reputation sync. Field introduced in 20.1.1. // Required: true IPReputationConfig *IPReputationConfig `json:"ip_reputation_config"` // Mode helps log collection and upload. Enum options - SALESFORCE, SYSTEST, MYVMWARE. Field introduced in 20.1.2. Allowed in Basic(Allowed values- SALESFORCE,MYVMWARE,SYSTEST) edition, Essentials(Allowed values- SALESFORCE,MYVMWARE,SYSTEST) edition, Enterprise edition. Mode *string `json:"mode,omitempty"` // Time interval in minutes. Allowed values are 5-60. Field introduced in 18.2.6. PollingInterval *int32 `json:"polling_interval,omitempty"` // The FQDN or IP address of the customer portal. Field introduced in 18.2.6. // Required: true PortalURL *string `json:"portal_url"` // Default values to be used during proactive case creation and techsupport attachment. Field introduced in 20.1.1. // Required: true ProactiveSupportDefaults *ProactiveSupportDefaults `json:"proactive_support_defaults"` // Split proxy configuration to connect external pulse services. Field introduced in 20.1.1. // Required: true SplitProxyConfiguration *ProxyConfiguration `json:"split_proxy_configuration"` // url // Read Only: true URL *string `json:"url,omitempty"` // By default, use system proxy configuration.If true, use split proxy configuration. Field introduced in 20.1.1. UseSplitProxy *bool `json:"use_split_proxy,omitempty"` // Secure the controller to PULSE communication over TLS. Field introduced in 20.1.3. UseTLS *bool `json:"use_tls,omitempty"` // Field introduced in 18.2.6. UUID *string `json:"uuid,omitempty"` }
ALBServicesConfig a l b services config swagger:model ALBServicesConfig
type ALBServicesConfigAPIResponse ¶
type ALBServicesConfigAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ALBServicesConfig `json:"results,omitempty"` }
ALBServicesConfigAPIResponse a l b services config Api response swagger:model ALBServicesConfigApiResponse
type ALBServicesFileUpload ¶
type ALBServicesFileUpload struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Salesforce alphanumeric CaseID to attach uploaded file to. Field introduced in 18.2.6. CaseID *string `json:"case_id,omitempty"` // Error reported during file upload. Field introduced in 18.2.6. // Read Only: true Error *string `json:"error,omitempty"` // Stores output file path, for upload to AWS S3. Field introduced in 18.2.6. // Required: true FilePath *string `json:"file_path"` // Field introduced in 18.2.6. // Required: true Name *string `json:"name"` // Custom AWS S3 Directory Path to upload file. Field introduced in 18.2.6. S3Directory *string `json:"s3_directory,omitempty"` // Captures status for file upload. Enum options - SYSERR_SUCCESS, SYSERR_FAILURE, SYSERR_OUT_OF_MEMORY, SYSERR_NO_ENT, SYSERR_INVAL, SYSERR_ACCESS, SYSERR_FAULT, SYSERR_IO, SYSERR_TIMEOUT, SYSERR_NOT_SUPPORTED, SYSERR_NOT_READY, SYSERR_UPGRADE_IN_PROGRESS, SYSERR_WARM_START_IN_PROGRESS, SYSERR_TRY_AGAIN, SYSERR_NOT_UPGRADING, SYSERR_PENDING, SYSERR_EVENT_GEN_FAILURE, SYSERR_CONFIG_PARAM_MISSING, SYSERR_RANGE, SYSERR_BAD_REQUEST.... Field introduced in 18.2.6. // Read Only: true Status *string `json:"status,omitempty"` // It is a reference to an object of type Tenant. Field introduced in 18.2.6. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
ALBServicesFileUpload a l b services file upload swagger:model ALBServicesFileUpload
type ALBServicesFileUploadAPIResponse ¶
type ALBServicesFileUploadAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ALBServicesFileUpload `json:"results,omitempty"` }
ALBServicesFileUploadAPIResponse a l b services file upload Api response swagger:model ALBServicesFileUploadApiResponse
type ALBServicesStatusDetails ¶
type ALBServicesStatusDetails struct { // Connection status of the controller cluster to ALBServices. Enum options - ALBSERVICES_CONNECTIVITY_UNKNOWN, ALBSERVICES_DISCONNECTED, ALBSERVICES_CONNECTED. Field introduced in 18.2.6. Connectivity *string `json:"connectivity,omitempty"` // Status change reason. Field introduced in 18.2.6. Reason *string `json:"reason,omitempty"` // Registration status of the controller cluster to ALBServices. Enum options - ALBSERVICES_REGISTRATION_UNKNOWN, ALBSERVICES_REGISTERED, ALBSERVICES_DEREGISTERED. Field introduced in 18.2.6. Registration *string `json:"registration,omitempty"` }
ALBServicesStatusDetails a l b services status details swagger:model ALBServicesStatusDetails
type ALBServicesUser ¶
type ALBServicesUser struct { // ID of primary account of the portal user. Field introduced in 20.1.1. AccountID *string `json:"account_id,omitempty"` // Name of primary account of the portal user. Field introduced in 20.1.1. AccountName *string `json:"account_name,omitempty"` // Email ID of the portal user. Field introduced in 20.1.1. // Required: true Email *string `json:"email"` // Information about all the accounts managed by user in the customer portal. Field introduced in 20.1.1. ManagedAccounts []*ALBServicesAccount `json:"managed_accounts,omitempty"` // Name of the portal user. Field introduced in 20.1.1. Name *string `json:"name,omitempty"` // Phone number of the user. Field introduced in 20.1.1. Phone *string `json:"phone,omitempty"` }
ALBServicesUser a l b services user swagger:model ALBServicesUser
type APICConfiguration ¶
type APICConfiguration struct { // Name of the Avi specific tenant created within APIC. ApicAdminTenant *string `json:"apic_admin_tenant,omitempty"` // vCenter's virtual machine manager domain within APIC. ApicDomain *string `json:"apic_domain,omitempty"` // The hostname or IP address of the APIC controller. ApicName []string `json:"apic_name,omitempty"` // The password Avi Vantage will use when authenticating with APIC. ApicPassword *string `json:"apic_password,omitempty"` // Field deprecated in 17.2.10,18.1.2. ApicProduct *string `json:"apic_product,omitempty"` // The username Avi Vantage will use when authenticating with APIC. ApicUsername *string `json:"apic_username,omitempty"` // Field deprecated in 17.2.10,18.1.2. ApicVendor *string `json:"apic_vendor,omitempty"` // The password APIC will use when authenticating with Avi Vantage. Field deprecated in 17.2.10,18.1.2. AviControllerPassword *string `json:"avi_controller_password,omitempty"` // The username APIC will use when authenticating with Avi Vantage. Field deprecated in 17.2.10,18.1.2. AviControllerUsername *string `json:"avi_controller_username,omitempty"` // Context aware for supporting Service Graphs across VRFs. Enum options - SINGLE_CONTEXT, MULTI_CONTEXT. ContextAware *string `json:"context_aware,omitempty"` // Field deprecated in 17.2.10,18.1.2. Deployment *string `json:"deployment,omitempty"` // Use Managed Mode for APIC Service Insertion. Field deprecated in 17.2.10,18.1.2. Field introduced in 17.1.1. ManagedMode *bool `json:"managed_mode,omitempty"` // AVI Device Package Minor Version. Field deprecated in 17.2.10,18.1.2. Minor *string `json:"minor,omitempty"` // Determines if DSR from secondary SE is active or not False DSR active. Please ensure that APIC BD's Endpoint Dataplane Learning is disabled True Disable DSR unconditionally. . Field introduced in 17.2.10,18.1.2. SeTunnelMode *bool `json:"se_tunnel_mode,omitempty"` // AVI Device Package Version. Field deprecated in 17.2.10,18.1.2. Version *string `json:"version,omitempty"` }
APICConfiguration API c configuration swagger:model APICConfiguration
type APICLifsRuntime ¶
type APICLifsRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Placeholder for description of property auto_allocated of obj type APICLifsRuntime field type str type boolean AutoAllocated *bool `json:"auto_allocated,omitempty"` // Placeholder for description of property cifs of obj type APICLifsRuntime field type str type object Cifs []*Cif `json:"cifs,omitempty"` // Contract Graph associated with the VirtualService. Field introduced in 17.2.14,18.1.5,18.2.1. ContractGraphs []string `json:"contract_graphs,omitempty"` // lif_label of APICLifsRuntime. // Required: true LifLabel *string `json:"lif_label"` // Placeholder for description of property multi_vrf of obj type APICLifsRuntime field type str type boolean MultiVrf *bool `json:"multi_vrf,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // network of APICLifsRuntime. Network *string `json:"network,omitempty"` // Unique object identifier of se. SeUUID []string `json:"se_uuid,omitempty"` // subnet of APICLifsRuntime. Subnet *string `json:"subnet,omitempty"` // tenant_name of APICLifsRuntime. // Required: true TenantName *string `json:"tenant_name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Unique object identifier of transaction. TransactionUUID []string `json:"transaction_uuid,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Unique object identifier of vs. VsUUID []string `json:"vs_uuid,omitempty"` }
APICLifsRuntime API c lifs runtime swagger:model APICLifsRuntime
type APICLifsRuntimeAPIResponse ¶
type APICLifsRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*APICLifsRuntime `json:"results,omitempty"` }
APICLifsRuntimeAPIResponse API c lifs runtime Api response swagger:model APICLifsRuntimeApiResponse
type APICNetworkRel ¶
type APICNetworkRel struct { // connector of APICNetworkRel. Connector *string `json:"connector,omitempty"` // rel_key of APICNetworkRel. RelKey *string `json:"rel_key,omitempty"` // target_network of APICNetworkRel. TargetNetwork *string `json:"target_network,omitempty"` }
APICNetworkRel API c network rel swagger:model APICNetworkRel
type APIVersionDeprecated ¶
type APIVersionDeprecated struct { // API version used. Field introduced in 21.1.1. APIVersionUsed *string `json:"api_version_used,omitempty"` // IP address of client who sent the request. Field introduced in 21.1.1. ClientIP *string `json:"client_ip,omitempty"` // Minimum supported API version. Field introduced in 21.1.1. MinSupportedAPIVersion *string `json:"min_supported_api_version,omitempty"` // URI of the request. Field introduced in 21.1.1. Path *string `json:"path,omitempty"` // User who sent the request. Field introduced in 21.1.1. User *string `json:"user,omitempty"` }
APIVersionDeprecated Api version deprecated swagger:model ApiVersionDeprecated
type AWSASGDelete ¶
type AWSASGDelete struct { // List of Autoscale groups deleted from AWS. Field introduced in 17.2.10,18.1.2. Asgs []string `json:"asgs,omitempty"` // UUID of the cloud. Field introduced in 17.2.10,18.1.2. CcID *string `json:"cc_id,omitempty"` // UUID of the Pool. Field introduced in 17.2.10,18.1.2. PoolUUID *string `json:"pool_uuid,omitempty"` }
AWSASGDelete a w s a s g delete swagger:model AWSASGDelete
type AWSASGNotifDetails ¶
type AWSASGNotifDetails struct { // asg_name of AWSASGNotifDetails. AsgName *string `json:"asg_name,omitempty"` // cc_id of AWSASGNotifDetails. CcID *string `json:"cc_id,omitempty"` // error_string of AWSASGNotifDetails. ErrorString *string `json:"error_string,omitempty"` // event_type of AWSASGNotifDetails. EventType *string `json:"event_type,omitempty"` // instance_id of AWSASGNotifDetails. InstanceID *string `json:"instance_id,omitempty"` // Placeholder for description of property instance_ip_addr of obj type AWSASGNotifDetails field type str type object InstanceIPAddr *IPAddr `json:"instance_ip_addr,omitempty"` // UUID of the Pool. It is a reference to an object of type Pool. Field introduced in 17.2.3. PoolRef *string `json:"pool_ref,omitempty"` // vpc_id of AWSASGNotifDetails. VpcID *string `json:"vpc_id,omitempty"` }
AWSASGNotifDetails a w s a s g notif details swagger:model AWSASGNotifDetails
type AWSLogin ¶
type AWSLogin struct { // access_key_id of AWSLogin. AccessKeyID *string `json:"access_key_id,omitempty"` // iam_assume_role of AWSLogin. IamAssumeRole *string `json:"iam_assume_role,omitempty"` // AWS region. Region *string `json:"region,omitempty"` // secret_access_key of AWSLogin. SecretAccessKey *string `json:"secret_access_key,omitempty"` // Placeholder for description of property use_iam_roles of obj type AWSLogin field type str type boolean UseIamRoles *bool `json:"use_iam_roles,omitempty"` // vpc_id of AWSLogin. VpcID *string `json:"vpc_id,omitempty"` }
AWSLogin a w s login swagger:model AWSLogin
type AWSSetup ¶
type AWSSetup struct { // access_key_id of AWSSetup. AccessKeyID *string `json:"access_key_id,omitempty"` // cc_id of AWSSetup. CcID *string `json:"cc_id,omitempty"` // error_string of AWSSetup. ErrorString *string `json:"error_string,omitempty"` // Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Privilege *string `json:"privilege,omitempty"` // region of AWSSetup. // Required: true Region *string `json:"region"` // Field introduced in 17.1.3. VpcID *string `json:"vpc_id,omitempty"` }
AWSSetup a w s setup swagger:model AWSSetup
type AbPool ¶
type AbPool struct { // Pool configured as B pool for A/B testing. It is a reference to an object of type Pool. // Required: true PoolRef *string `json:"pool_ref"` // Ratio of traffic diverted to the B pool, for A/B testing. Allowed values are 0-100. Ratio *int32 `json:"ratio,omitempty"` }
AbPool ab pool swagger:model AbPool
type ActionGroupConfig ¶
type ActionGroupConfig struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // reference of the action script configuration to be used. It is a reference to an object of type AlertScriptConfig. ActionScriptConfigRef *string `json:"action_script_config_ref,omitempty"` // Trigger Notification to AutoScale Manager. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AutoscaleTriggerNotification *bool `json:"autoscale_trigger_notification,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Select the Email Notification configuration to use when sending alerts via email. It is a reference to an object of type AlertEmailConfig. EmailConfigRef *string `json:"email_config_ref,omitempty"` // Generate Alert only to external destinations. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. // Required: true ExternalOnly *bool `json:"external_only"` // When an alert is generated, mark its priority via the Alert Level. Enum options - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH. // Required: true Level *string `json:"level"` // Name of the object. // Required: true Name *string `json:"name"` // Select the SNMP Trap Notification to use when sending alerts via SNMP Trap. It is a reference to an object of type SnmpTrapProfile. SnmpTrapProfileRef *string `json:"snmp_trap_profile_ref,omitempty"` // Select the Syslog Notification configuration to use when sending alerts via Syslog. It is a reference to an object of type AlertSyslogConfig. SyslogConfigRef *string `json:"syslog_config_ref,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
ActionGroupConfig action group config swagger:model ActionGroupConfig
type ActionGroupConfigAPIResponse ¶
type ActionGroupConfigAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ActionGroupConfig `json:"results,omitempty"` }
ActionGroupConfigAPIResponse action group config Api response swagger:model ActionGroupConfigApiResponse
type AdminAuthConfiguration ¶
type AdminAuthConfiguration struct { // Allow any user created locally to login with local credentials. Field introduced in 17.1.1. AllowLocalUserLogin *bool `json:"allow_local_user_login,omitempty"` // It is a reference to an object of type AuthProfile. AuthProfileRef *string `json:"auth_profile_ref,omitempty"` // Rules list for tenant or role mapping. MappingRules []*AuthMappingRule `json:"mapping_rules,omitempty"` }
AdminAuthConfiguration admin auth configuration swagger:model AdminAuthConfiguration
type Alert ¶
type Alert struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Output of the alert action script. ActionScriptOutput *string `json:"action_script_output,omitempty"` // It is a reference to an object of type AlertConfig. // Required: true AlertConfigRef *string `json:"alert_config_ref"` // Placeholder for description of property app_events of obj type Alert field type str type object AppEvents []*ApplicationLog `json:"app_events,omitempty"` // Placeholder for description of property conn_events of obj type Alert field type str type object ConnEvents []*ConnectionLog `json:"conn_events,omitempty"` // alert generation criteria. Description *string `json:"description,omitempty"` // List of event pages this alert is associated with. EventPages []string `json:"event_pages,omitempty"` // Placeholder for description of property events of obj type Alert field type str type object Events []*EventLog `json:"events,omitempty"` // Unix Timestamp of the last throttling in seconds. LastThrottleTimestamp *float64 `json:"last_throttle_timestamp,omitempty"` // Resolved Alert Type. Enum options - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH. // Required: true Level *string `json:"level"` // Placeholder for description of property metric_info of obj type Alert field type str type object MetricInfo []*MetricLog `json:"metric_info,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // UUID of the resource. // Required: true ObjKey *string `json:"obj_key"` // Name of the resource. ObjName *string `json:"obj_name,omitempty"` // UUID of the resource. // Required: true ObjUUID *string `json:"obj_uuid"` // reason of Alert. // Required: true Reason *string `json:"reason"` // related uuids for the connection log. Only Log agent needs to fill this. Server uuid should be in formatpool_uuid-ip-port. In case of no port is set for server it shouldstill be operational port for the server. RelatedUuids []string `json:"related_uuids,omitempty"` // State of the alert. It would be active when createdIt would be changed to state read when read by the admin. Enum options - ALERT_STATE_ON, ALERT_STATE_DISMISSED, ALERT_STATE_THROTTLED. // Required: true State *string `json:"state"` // summary of alert based on alert config. // Required: true Summary *string `json:"summary"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Number of threshold. Threshold *int32 `json:"threshold,omitempty"` // Number of times it was throttled. ThrottleCount *int32 `json:"throttle_count,omitempty"` // Unix Timestamp of the last throttling in seconds. // Required: true Timestamp *float64 `json:"timestamp"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
Alert alert swagger:model Alert
type AlertAPIResponse ¶
type AlertAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Alert `json:"results,omitempty"` }
AlertAPIResponse alert Api response swagger:model AlertApiResponse
type AlertConfig ¶
type AlertConfig struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // The alert config will trigger the selected alert action, which can send notifications and execute a controlscript. It is a reference to an object of type ActionGroupConfig. ActionGroupRef *string `json:"action_group_ref,omitempty"` // list of filters matching on events or client logs used for triggering alerts. // Required: true AlertRule *AlertRule `json:"alert_rule"` // This alert config applies to auto scale alerts. AutoscaleAlert *bool `json:"autoscale_alert,omitempty"` // Determines whether an alert is raised immediately when event occurs (realtime) or after specified number of events occurs within rolling time window. Enum options - REALTIME, ROLLINGWINDOW, WATERMARK. // Required: true Category *string `json:"category"` // A custom description field. Description *string `json:"description,omitempty"` // Enable or disable this alert config from generating new alerts. Enabled *bool `json:"enabled,omitempty"` // An alert is expired and deleted after the expiry time has elapsed. The original event triggering the alert remains in the event's log. Allowed values are 1-31536000. Unit is SEC. ExpiryTime *int32 `json:"expiry_time,omitempty"` // Name of the alert configuration. // Required: true Name *string `json:"name"` // UUID of the resource for which alert was raised. ObjUUID *string `json:"obj_uuid,omitempty"` // The object type to which the Alert Config is associated with. Valid object types are - Virtual Service, Pool, Service Engine. Enum options - VIRTUALSERVICE, POOL, HEALTHMONITOR, NETWORKPROFILE, APPLICATIONPROFILE, HTTPPOLICYSET, DNSPOLICY, SECURITYPOLICY, IPADDRGROUP, STRINGGROUP, SSLPROFILE, SSLKEYANDCERTIFICATE, NETWORKSECURITYPOLICY, APPLICATIONPERSISTENCEPROFILE, ANALYTICSPROFILE, VSDATASCRIPTSET, TENANT, PKIPROFILE, AUTHPROFILE, CLOUD... ObjectType *string `json:"object_type,omitempty"` // recommendation of AlertConfig. Recommendation *string `json:"recommendation,omitempty"` // Only if the Number of Events is reached or exceeded within the Time Window will an alert be generated. Allowed values are 1-31536000. Unit is SEC. RollingWindow *int32 `json:"rolling_window,omitempty"` // Signifies system events or the type of client logsused in this alert configuration. Enum options - CONN_LOGS, APP_LOGS, EVENT_LOGS, METRICS. // Required: true Source *string `json:"source"` // Summary of reason why alert is generated. Summary *string `json:"summary,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // An alert is created only when the number of events meets or exceeds this number within the chosen time frame. Allowed values are 1-65536. Threshold *int32 `json:"threshold,omitempty"` // Alerts are suppressed (throttled) for this duration of time since the last alert was raised for this alert config. Allowed values are 0-31536000. Unit is SEC. Throttle *int32 `json:"throttle,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
AlertConfig alert config swagger:model AlertConfig
type AlertConfigAPIResponse ¶
type AlertConfigAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*AlertConfig `json:"results,omitempty"` }
AlertConfigAPIResponse alert config Api response swagger:model AlertConfigApiResponse
type AlertEmailConfig ¶
type AlertEmailConfig struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Alerts are copied to the comma separated list of email recipients. CcEmails *string `json:"cc_emails,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // A user-friendly name of the email notification service. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Alerts are sent to the comma separated list of email recipients. // Required: true ToEmails *string `json:"to_emails"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
AlertEmailConfig alert email config swagger:model AlertEmailConfig
type AlertEmailConfigAPIResponse ¶
type AlertEmailConfigAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*AlertEmailConfig `json:"results,omitempty"` }
AlertEmailConfigAPIResponse alert email config Api response swagger:model AlertEmailConfigApiResponse
type AlertFilter ¶
type AlertFilter struct { // filter_action of AlertFilter. FilterAction *string `json:"filter_action,omitempty"` // filter_string of AlertFilter. // Required: true FilterString *string `json:"filter_string"` }
AlertFilter alert filter swagger:model AlertFilter
type AlertMetricThreshold ¶
type AlertMetricThreshold struct { // Enum options - ALERT_OP_LT, ALERT_OP_LE, ALERT_OP_EQ, ALERT_OP_NE, ALERT_OP_GE, ALERT_OP_GT. // Required: true Comparator *string `json:"comparator"` // Metric threshold for comparison. Threshold *int32 `json:"threshold,omitempty"` }
AlertMetricThreshold alert metric threshold swagger:model AlertMetricThreshold
type AlertMgrDebugFilter ¶
type AlertMgrDebugFilter struct { // filter debugs for entity uuid. AlertObjid *string `json:"alert_objid,omitempty"` // filter debugs for an alert id. AlertUUID *string `json:"alert_uuid,omitempty"` // filter debugs for an alert config. CfgUUID *string `json:"cfg_uuid,omitempty"` }
AlertMgrDebugFilter alert mgr debug filter swagger:model AlertMgrDebugFilter
type AlertObjectList ¶
type AlertObjectList struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Enum options - VIRTUALSERVICE. POOL. HEALTHMONITOR. NETWORKPROFILE. APPLICATIONPROFILE. HTTPPOLICYSET. DNSPOLICY. SECURITYPOLICY. IPADDRGROUP. STRINGGROUP. SSLPROFILE. SSLKEYANDCERTIFICATE. NETWORKSECURITYPOLICY. APPLICATIONPERSISTENCEPROFILE. ANALYTICSPROFILE. VSDATASCRIPTSET. TENANT. PKIPROFILE. AUTHPROFILE. CLOUD... Objects []string `json:"objects,omitempty"` // Enum options - CONN_LOGS, APP_LOGS, EVENT_LOGS, METRICS. // Required: true Source *string `json:"source"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
AlertObjectList alert object list swagger:model AlertObjectList
type AlertObjectListAPIResponse ¶
type AlertObjectListAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*AlertObjectList `json:"results,omitempty"` }
AlertObjectListAPIResponse alert object list Api response swagger:model AlertObjectListApiResponse
type AlertRule ¶
type AlertRule struct { // Placeholder for description of property conn_app_log_rule of obj type AlertRule field type str type object ConnAppLogRule *AlertFilter `json:"conn_app_log_rule,omitempty"` // event_match_filter of AlertRule. EventMatchFilter *string `json:"event_match_filter,omitempty"` // Placeholder for description of property metrics_rule of obj type AlertRule field type str type object MetricsRule []*AlertRuleMetric `json:"metrics_rule,omitempty"` // Enum options - OPERATOR_AND, OPERATOR_OR. Operator *string `json:"operator,omitempty"` // Placeholder for description of property sys_event_rule of obj type AlertRule field type str type object SysEventRule []*AlertRuleEvent `json:"sys_event_rule,omitempty"` }
AlertRule alert rule swagger:model AlertRule
type AlertRuleEvent ¶
type AlertRuleEvent struct { // Placeholder for description of property event_details of obj type AlertRuleEvent field type str type object EventDetails []*EventDetailsFilter `json:"event_details,omitempty"` // When the selected event occurs, trigger this alert. Enum options - VINFRA_DISC_DC, VINFRA_DISC_HOST, VINFRA_DISC_CLUSTER, VINFRA_DISC_VM, VINFRA_DISC_NW, MGMT_NW_NAME_CHANGED, DISCOVERY_DATACENTER_DEL, VM_ADDED, VM_REMOVED, VINFRA_DISC_COMPLETE, VCENTER_ADDRESS_ERROR, SE_GROUP_CLUSTER_DEL, SE_GROUP_MGMT_NW_DEL, MGMT_NW_DEL, VCENTER_BAD_CREDENTIALS, ESX_HOST_UNREACHABLE, SERVER_DELETED, SE_GROUP_HOST_DEL, VINFRA_DISC_FAILURE, ESX_HOST_POWERED_DOWN... EventID *string `json:"event_id,omitempty"` // Placeholder for description of property not_cond of obj type AlertRuleEvent field type str type boolean NotCond *bool `json:"not_cond,omitempty"` }
AlertRuleEvent alert rule event swagger:model AlertRuleEvent
type AlertRuleMetric ¶
type AlertRuleMetric struct { // Evaluation window for the Metrics. Unit is SEC. Duration *int32 `json:"duration,omitempty"` // Metric Id for the Alert. Eg. l4_client.avg_complete_conns. MetricID *string `json:"metric_id,omitempty"` // Placeholder for description of property metric_threshold of obj type AlertRuleMetric field type str type object // Required: true MetricThreshold *AlertMetricThreshold `json:"metric_threshold"` }
AlertRuleMetric alert rule metric swagger:model AlertRuleMetric
type AlertScriptConfig ¶
type AlertScriptConfig struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // User Defined Alert Action Script. Please refer to kb.avinetworks.com for more information. ActionScript *string `json:"action_script,omitempty"` // A user-friendly name of the Script. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
AlertScriptConfig alert script config swagger:model AlertScriptConfig
type AlertScriptConfigAPIResponse ¶
type AlertScriptConfigAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*AlertScriptConfig `json:"results,omitempty"` }
AlertScriptConfigAPIResponse alert script config Api response swagger:model AlertScriptConfigApiResponse
type AlertSyslogConfig ¶
type AlertSyslogConfig struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // User defined description for alert syslog config. Description *string `json:"description,omitempty"` // A user-friendly name of the syslog notification. // Required: true Name *string `json:"name"` // The list of syslog servers. SyslogServers []*AlertSyslogServer `json:"syslog_servers,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
AlertSyslogConfig alert syslog config swagger:model AlertSyslogConfig
type AlertSyslogConfigAPIResponse ¶
type AlertSyslogConfigAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*AlertSyslogConfig `json:"results,omitempty"` }
AlertSyslogConfigAPIResponse alert syslog config Api response swagger:model AlertSyslogConfigApiResponse
type AlertSyslogServer ¶
type AlertSyslogServer struct { // Enable anonymous authentication of Syslog Serverwhich will disable server certificate authentication. Field introduced in 17.2.17, 18.2.5. AnonAuth *bool `json:"anon_auth,omitempty"` // Syslog output format - legacy, RFC 5424, JSON. Enum options - SYSLOG_LEGACY, SYSLOG_RFC5424, SYSLOG_JSON, SYSLOG_RFC5425_ENHANCED. Field introduced in 17.2.8. Format *string `json:"format,omitempty"` // Select the PKIProfile containing a CA or list of CA chainswhich will validate the certificate of the syslog server. It is a reference to an object of type PKIProfile. Field introduced in 17.2.17, 18.2.5. PkiprofileRef *string `json:"pkiprofile_ref,omitempty"` // Select a certificate and key which will be used to authenticate to the syslog server. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 17.2.17, 18.2.5. SslKeyAndCertificateRef *string `json:"ssl_key_and_certificate_ref,omitempty"` // The destination Syslog server IP address or hostname. // Required: true SyslogServer *string `json:"syslog_server"` // The destination Syslog server's service port. SyslogServerPort *int32 `json:"syslog_server_port,omitempty"` // Enable TLS to the syslog server. Field introduced in 17.2.16, 18.2.3. TLSEnable *bool `json:"tls_enable,omitempty"` // Network protocol to establish syslog session. // Required: true UDP *bool `json:"udp"` }
AlertSyslogServer alert syslog server swagger:model AlertSyslogServer
type AlertTestEmailParams ¶
type AlertTestEmailParams struct { // The Subject line of the originating email from Avi Controller. // Required: true Subject *string `json:"subject"` // The email context. // Required: true Text *string `json:"text"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
AlertTestEmailParams alert test email params swagger:model AlertTestEmailParams
type AlertTestSyslogSnmpParams ¶
type AlertTestSyslogSnmpParams struct { // The contents of the Syslog message/SNMP Trap contents. // Required: true Text *string `json:"text"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
AlertTestSyslogSnmpParams alert test syslog snmp params swagger:model AlertTestSyslogSnmpParams
type AllSeUpgradeEventDetails ¶
type AllSeUpgradeEventDetails struct { // notes of AllSeUpgradeEventDetails. Notes []string `json:"notes,omitempty"` // Number of num_se. // Required: true NumSe *int32 `json:"num_se"` // Number of num_vs. NumVs *int32 `json:"num_vs,omitempty"` // Placeholder for description of property request of obj type AllSeUpgradeEventDetails field type str type object Request *SeUpgradeParams `json:"request,omitempty"` }
AllSeUpgradeEventDetails all se upgrade event details swagger:model AllSeUpgradeEventDetails
type AnalyticsPolicy ¶
type AnalyticsPolicy struct { // Log all headers. Field introduced in 18.1.4, 18.2.1. AllHeaders *bool `json:"all_headers,omitempty"` // Gain insights from sampled client to server HTTP requests and responses. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. ClientInsights *string `json:"client_insights,omitempty"` // Placeholder for description of property client_insights_sampling of obj type AnalyticsPolicy field type str type object ClientInsightsSampling *ClientInsightsSampling `json:"client_insights_sampling,omitempty"` // Placeholder for description of property client_log_filters of obj type AnalyticsPolicy field type str type object ClientLogFilters []*ClientLogFilter `json:"client_log_filters,omitempty"` // [DEPRECATED] Disable Analytics on this VirtualService. This will disable the collection of both metrics and logs. Please use following fields in AnalytcsProfile to control this behavior instead. disable_vs_analytics (for VirtualServices metrics), disable_server_analytics (for Pool metrics) and client_log_config (for logs). Field deprecated in 18.2.1. Field introduced in 17.2.4. Enabled *bool `json:"enabled,omitempty"` // Placeholder for description of property full_client_logs of obj type AnalyticsPolicy field type str type object FullClientLogs *FullClientLogs `json:"full_client_logs,omitempty"` // Configuration for learning logging determining whether it's enabled and where is the destination. Field introduced in 20.1.3. LearningLogPolicy *LearningLogPolicy `json:"learning_log_policy,omitempty"` // Settings to turn on realtime metrics and set duration for realtime updates. MetricsRealtimeUpdate *MetricsRealTimeUpdate `json:"metrics_realtime_update,omitempty"` // This setting limits the number of significant logs generated per second for this VS on each SE. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. SignificantLogThrottle *int32 `json:"significant_log_throttle,omitempty"` // This setting limits the total number of UDF logs generated per second for this VS on each SE. UDF logs are generated due to the configured client log filters or the rules with logging enabled. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. UdfLogThrottle *int32 `json:"udf_log_throttle,omitempty"` }
AnalyticsPolicy analytics policy swagger:model AnalyticsPolicy
type AnalyticsProfile ¶
type AnalyticsProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // If a client receives an HTTP response in less than the Satisfactory Latency Threshold, the request is considered Satisfied. It is considered Tolerated if it is not Satisfied and less than Tolerated Latency Factor multiplied by the Satisfactory Latency Threshold. Greater than this number and the client's request is considered Frustrated. Allowed values are 1-30000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 500) edition, Essentials(Allowed values- 500) edition, Enterprise edition. ApdexResponseThreshold *int32 `json:"apdex_response_threshold,omitempty"` // Client tolerated response latency factor. Client must receive a response within this factor times the satisfactory threshold (apdex_response_threshold) to be considered tolerated. Allowed values are 1-1000. Allowed in Basic(Allowed values- 4) edition, Essentials(Allowed values- 4) edition, Enterprise edition. ApdexResponseToleratedFactor *float64 `json:"apdex_response_tolerated_factor,omitempty"` // Satisfactory client to Avi Round Trip Time(RTT). Allowed values are 1-2000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 250) edition, Essentials(Allowed values- 250) edition, Enterprise edition. ApdexRttThreshold *int32 `json:"apdex_rtt_threshold,omitempty"` // Tolerated client to Avi Round Trip Time(RTT) factor. It is a multiple of apdex_rtt_tolerated_factor. Allowed values are 1-1000. Allowed in Basic(Allowed values- 4) edition, Essentials(Allowed values- 4) edition, Enterprise edition. ApdexRttToleratedFactor *float64 `json:"apdex_rtt_tolerated_factor,omitempty"` // If a client is able to load a page in less than the Satisfactory Latency Threshold, the PageLoad is considered Satisfied. It is considered tolerated if it is greater than Satisfied but less than the Tolerated Latency multiplied by Satisifed Latency. Greater than this number and the client's request is considered Frustrated. A PageLoad includes the time for DNS lookup, download of all HTTP objects, and page render time. Allowed values are 1-30000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 5000) edition, Essentials(Allowed values- 5000) edition, Enterprise edition. ApdexRumThreshold *int32 `json:"apdex_rum_threshold,omitempty"` // Virtual service threshold factor for tolerated Page Load Time (PLT) as multiple of apdex_rum_threshold. Allowed values are 1-1000. Allowed in Basic(Allowed values- 4) edition, Essentials(Allowed values- 4) edition, Enterprise edition. ApdexRumToleratedFactor *float64 `json:"apdex_rum_tolerated_factor,omitempty"` // A server HTTP response is considered Satisfied if latency is less than the Satisfactory Latency Threshold. The response is considered tolerated when it is greater than Satisfied but less than the Tolerated Latency Factor * S_Latency. Greater than this number and the server response is considered Frustrated. Allowed values are 1-30000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 400) edition, Essentials(Allowed values- 400) edition, Enterprise edition. ApdexServerResponseThreshold *int32 `json:"apdex_server_response_threshold,omitempty"` // Server tolerated response latency factor. Servermust response within this factor times the satisfactory threshold (apdex_server_response_threshold) to be considered tolerated. Allowed values are 1-1000. Allowed in Basic(Allowed values- 4) edition, Essentials(Allowed values- 4) edition, Enterprise edition. ApdexServerResponseToleratedFactor *float64 `json:"apdex_server_response_tolerated_factor,omitempty"` // Satisfactory client to Avi Round Trip Time(RTT). Allowed values are 1-2000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 125) edition, Essentials(Allowed values- 125) edition, Enterprise edition. ApdexServerRttThreshold *int32 `json:"apdex_server_rtt_threshold,omitempty"` // Tolerated client to Avi Round Trip Time(RTT) factor. It is a multiple of apdex_rtt_tolerated_factor. Allowed values are 1-1000. Allowed in Basic(Allowed values- 4) edition, Essentials(Allowed values- 4) edition, Enterprise edition. ApdexServerRttToleratedFactor *float64 `json:"apdex_server_rtt_tolerated_factor,omitempty"` // Configure which logs are sent to the Avi Controller from SEs and how they are processed. ClientLogConfig *ClientLogConfiguration `json:"client_log_config,omitempty"` // Configure to stream logs to an external server. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. ClientLogStreamingConfig *ClientLogStreamingConfig `json:"client_log_streaming_config,omitempty"` // A connection between client and Avi is considered lossy when more than this percentage of out of order packets are received. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 50) edition, Essentials(Allowed values- 50) edition, Enterprise edition. ConnLossyOooThreshold *int32 `json:"conn_lossy_ooo_threshold,omitempty"` // A connection between client and Avi is considered lossy when more than this percentage of packets are retransmitted due to timeout. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 20) edition, Essentials(Allowed values- 20) edition, Enterprise edition. ConnLossyTimeoRexmtThreshold *int32 `json:"conn_lossy_timeo_rexmt_threshold,omitempty"` // A connection between client and Avi is considered lossy when more than this percentage of packets are retransmitted. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 50) edition, Essentials(Allowed values- 50) edition, Enterprise edition. ConnLossyTotalRexmtThreshold *int32 `json:"conn_lossy_total_rexmt_threshold,omitempty"` // A client connection is considered lossy when percentage of times a packet could not be trasmitted due to TCP zero window is above this threshold. Allowed values are 0-100. Unit is PERCENT. Allowed in Basic(Allowed values- 2) edition, Essentials(Allowed values- 2) edition, Enterprise edition. ConnLossyZeroWinSizeEventThreshold *int32 `json:"conn_lossy_zero_win_size_event_threshold,omitempty"` // A connection between Avi and server is considered lossy when more than this percentage of out of order packets are received. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 50) edition, Essentials(Allowed values- 50) edition, Enterprise edition. ConnServerLossyOooThreshold *int32 `json:"conn_server_lossy_ooo_threshold,omitempty"` // A connection between Avi and server is considered lossy when more than this percentage of packets are retransmitted due to timeout. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 20) edition, Essentials(Allowed values- 20) edition, Enterprise edition. ConnServerLossyTimeoRexmtThreshold *int32 `json:"conn_server_lossy_timeo_rexmt_threshold,omitempty"` // A connection between Avi and server is considered lossy when more than this percentage of packets are retransmitted. Allowed values are 1-100. Unit is PERCENT. Allowed in Basic(Allowed values- 50) edition, Essentials(Allowed values- 50) edition, Enterprise edition. ConnServerLossyTotalRexmtThreshold *int32 `json:"conn_server_lossy_total_rexmt_threshold,omitempty"` // A server connection is considered lossy when percentage of times a packet could not be trasmitted due to TCP zero window is above this threshold. Allowed values are 0-100. Unit is PERCENT. Allowed in Basic(Allowed values- 2) edition, Essentials(Allowed values- 2) edition, Enterprise edition. ConnServerLossyZeroWinSizeEventThreshold *int32 `json:"conn_server_lossy_zero_win_size_event_threshold,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Virtual Service (VS) metrics are processed only when there is live data traffic on the VS. In case, VS is idle for a period of time as specified by ondemand_metrics_idle_timeout then metrics processing is suspended for that VS. Field deprecated in 20.1.3. Field introduced in 18.1.1. DisableOndemandMetrics *bool `json:"disable_ondemand_metrics,omitempty"` // Disable node (service engine) level analytics forvs metrics. Field deprecated in 20.1.3. DisableSeAnalytics *bool `json:"disable_se_analytics,omitempty"` // Disable analytics on backend servers. This may be desired in container environment when there are large number of ephemeral servers. Additionally, no healthscore of servers is computed when server analytics is disabled. Field deprecated in 20.1.3. DisableServerAnalytics *bool `json:"disable_server_analytics,omitempty"` // Disable VirtualService (frontend) Analytics. This flag disables metrics and healthscore for Virtualservice. Field deprecated in 20.1.3. Field introduced in 18.2.1. DisableVsAnalytics *bool `json:"disable_vs_analytics,omitempty"` // Enable adaptive configuration for optimizing resource usage. Field introduced in 20.1.1. EnableAdaptiveConfig *bool `json:"enable_adaptive_config,omitempty"` // Enables Advanced Analytics features like Anomaly detection. If set to false, anomaly computation (and associated rules/events) for VS, Pool and Server metrics will be deactivated. However, setting it to false reduces cpu and memory requirements for Analytics subsystem. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. EnableAdvancedAnalytics *bool `json:"enable_advanced_analytics,omitempty"` // Virtual Service (VS) metrics are processed only when there is live data traffic on the VS. In case, VS is idle for a period of time as specified by ondemand_metrics_idle_timeout then metrics processing is suspended for that VS. Field introduced in 20.1.3. EnableOndemandMetrics *bool `json:"enable_ondemand_metrics,omitempty"` // Enable node (service engine) level analytics forvs metrics. Field introduced in 20.1.3. EnableSeAnalytics *bool `json:"enable_se_analytics,omitempty"` // Enables analytics on backend servers. This may be desired in container environment when there are large number of ephemeral servers. Additionally, no healthscore of servers is computed when server analytics is enabled. Field introduced in 20.1.3. EnableServerAnalytics *bool `json:"enable_server_analytics,omitempty"` // Enable VirtualService (frontend) Analytics. This flag enables metrics and healthscore for Virtualservice. Field introduced in 20.1.3. EnableVsAnalytics *bool `json:"enable_vs_analytics,omitempty"` // Exclude client closed connection before an HTTP request could be completed from being classified as an error. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeClientCloseBeforeRequestAsError *bool `json:"exclude_client_close_before_request_as_error,omitempty"` // Exclude dns policy drops from the list of errors. Field introduced in 17.2.2. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeDNSPolicyDropAsSignificant *bool `json:"exclude_dns_policy_drop_as_significant,omitempty"` // Exclude queries to GSLB services that are operationally down from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeGsDownAsError *bool `json:"exclude_gs_down_as_error,omitempty"` // List of HTTP status codes to be excluded from being classified as an error. Error connections or responses impacts health score, are included as significant logs, and may be classified as part of a DoS attack. ExcludeHTTPErrorCodes []int64 `json:"exclude_http_error_codes,omitempty,omitempty"` // Exclude dns queries to domains outside the domains configured in the DNS application profile from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeInvalidDNSDomainAsError *bool `json:"exclude_invalid_dns_domain_as_error,omitempty"` // Exclude invalid dns queries from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeInvalidDNSQueryAsError *bool `json:"exclude_invalid_dns_query_as_error,omitempty"` // Exclude the Issuer-Revoked OCSP Responses from the list of errors. Field introduced in 20.1.1. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. ExcludeIssuerRevokedOcspResponsesAsError *bool `json:"exclude_issuer_revoked_ocsp_responses_as_error,omitempty"` // Exclude queries to domains that did not have configured services/records from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeNoDNSRecordAsError *bool `json:"exclude_no_dns_record_as_error,omitempty"` // Exclude queries to GSLB services that have no available members from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeNoValidGsMemberAsError *bool `json:"exclude_no_valid_gs_member_as_error,omitempty"` // Exclude persistence server changed while load balancing' from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludePersistenceChangeAsError *bool `json:"exclude_persistence_change_as_error,omitempty"` // Exclude the Revoked OCSP certificate status responses from the list of errors. Field introduced in 20.1.1. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. ExcludeRevokedOcspResponsesAsError *bool `json:"exclude_revoked_ocsp_responses_as_error,omitempty"` // Exclude server dns error response from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeServerDNSErrorAsError *bool `json:"exclude_server_dns_error_as_error,omitempty"` // Exclude server TCP reset from errors. It is common for applications like MS Exchange. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeServerTCPResetAsError *bool `json:"exclude_server_tcp_reset_as_error,omitempty"` // List of SIP status codes to be excluded from being classified as an error. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. ExcludeSipErrorCodes []int64 `json:"exclude_sip_error_codes,omitempty,omitempty"` // Exclude the Stale OCSP certificate status responses from the list of errors. Field introduced in 20.1.1. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. ExcludeStaleOcspResponsesAsError *bool `json:"exclude_stale_ocsp_responses_as_error,omitempty"` // Exclude 'server unanswered syns' from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeSynRetransmitAsError *bool `json:"exclude_syn_retransmit_as_error,omitempty"` // Exclude TCP resets by client from the list of potential errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeTCPResetAsError *bool `json:"exclude_tcp_reset_as_error,omitempty"` ExcludeUnavailableOcspResponsesAsError *bool `json:"exclude_unavailable_ocsp_responses_as_error,omitempty"` // Exclude unsupported dns queries from the list of errors. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ExcludeUnsupportedDNSQueryAsError *bool `json:"exclude_unsupported_dns_query_as_error,omitempty"` // Skips health score computation of pool servers when number of servers in a pool is more than this setting. Allowed values are 0-5000. Special values are 0- 'server health score is deactivated'. Field introduced in 17.2.13, 18.1.4. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Special default for Basic edition is 0, Essentials edition is 0, Enterprise is 20. HealthscoreMaxServerLimit *int32 `json:"healthscore_max_server_limit,omitempty"` // Time window (in secs) within which only unique health change events should occur. Allowed in Basic(Allowed values- 1209600) edition, Essentials(Allowed values- 1209600) edition, Enterprise edition. HsEventThrottleWindow *int32 `json:"hs_event_throttle_window,omitempty"` // Maximum penalty that may be deducted from health score for anomalies. Allowed values are 0-100. Allowed in Basic(Allowed values- 10) edition, Essentials(Allowed values- 10) edition, Enterprise edition. HsMaxAnomalyPenalty *int32 `json:"hs_max_anomaly_penalty,omitempty"` // Maximum penalty that may be deducted from health score for high resource utilization. Allowed values are 0-100. Allowed in Basic(Allowed values- 25) edition, Essentials(Allowed values- 25) edition, Enterprise edition. HsMaxResourcesPenalty *int32 `json:"hs_max_resources_penalty,omitempty"` // Maximum penalty that may be deducted from health score based on security assessment. Allowed values are 0-100. Allowed in Basic(Allowed values- 100) edition, Essentials(Allowed values- 100) edition, Enterprise edition. HsMaxSecurityPenalty *int32 `json:"hs_max_security_penalty,omitempty"` // DoS connection rate below which the DoS security assessment will not kick in. Allowed in Basic(Allowed values- 1000) edition, Essentials(Allowed values- 1000) edition, Enterprise edition. HsMinDosRate *int32 `json:"hs_min_dos_rate,omitempty"` // Adds free performance score credits to health score. It can be used for compensating health score for known slow applications. Allowed values are 0-100. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. HsPerformanceBoost *int32 `json:"hs_performance_boost,omitempty"` // Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed. Allowed in Basic(Allowed values- 10) edition, Essentials(Allowed values- 10) edition, Enterprise edition. HsPscoreTrafficThresholdL4Client *float64 `json:"hs_pscore_traffic_threshold_l4_client,omitempty"` // Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed. Allowed in Basic(Allowed values- 10) edition, Essentials(Allowed values- 10) edition, Enterprise edition. HsPscoreTrafficThresholdL4Server *float64 `json:"hs_pscore_traffic_threshold_l4_server,omitempty"` // Score assigned when the certificate has expired. Allowed values are 0-5. Allowed in Basic(Allowed values- 0.0) edition, Essentials(Allowed values- 0.0) edition, Enterprise edition. HsSecurityCertscoreExpired *float64 `json:"hs_security_certscore_expired,omitempty"` // Score assigned when the certificate expires in more than 30 days. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. HsSecurityCertscoreGt30d *float64 `json:"hs_security_certscore_gt30d,omitempty"` // Score assigned when the certificate expires in less than or equal to 7 days. Allowed values are 0-5. Allowed in Basic(Allowed values- 2.0) edition, Essentials(Allowed values- 2.0) edition, Enterprise edition. HsSecurityCertscoreLe07d *float64 `json:"hs_security_certscore_le07d,omitempty"` // Score assigned when the certificate expires in less than or equal to 30 days. Allowed values are 0-5. Allowed in Basic(Allowed values- 4.0) edition, Essentials(Allowed values- 4.0) edition, Enterprise edition. HsSecurityCertscoreLe30d *float64 `json:"hs_security_certscore_le30d,omitempty"` // Penalty for allowing certificates with invalid chain. Allowed values are 0-5. Allowed in Basic(Allowed values- 1.0) edition, Essentials(Allowed values- 1.0) edition, Enterprise edition. HsSecurityChainInvalidityPenalty *float64 `json:"hs_security_chain_invalidity_penalty,omitempty"` // Score assigned when the minimum cipher strength is 0 bits. Allowed values are 0-5. Allowed in Basic(Allowed values- 0.0) edition, Essentials(Allowed values- 0.0) edition, Enterprise edition. HsSecurityCipherscoreEq000b *float64 `json:"hs_security_cipherscore_eq000b,omitempty"` // Score assigned when the minimum cipher strength is greater than equal to 128 bits. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. HsSecurityCipherscoreGe128b *float64 `json:"hs_security_cipherscore_ge128b,omitempty"` // Score assigned when the minimum cipher strength is less than 128 bits. Allowed values are 0-5. Allowed in Basic(Allowed values- 3.5) edition, Essentials(Allowed values- 3.5) edition, Enterprise edition. HsSecurityCipherscoreLt128b *float64 `json:"hs_security_cipherscore_lt128b,omitempty"` // Score assigned when no algorithm is used for encryption. Allowed values are 0-5. Allowed in Basic(Allowed values- 0.0) edition, Essentials(Allowed values- 0.0) edition, Enterprise edition. HsSecurityEncalgoScoreNone *float64 `json:"hs_security_encalgo_score_none,omitempty"` // Score assigned when RC4 algorithm is used for encryption. Allowed values are 0-5. Allowed in Basic(Allowed values- 2.5) edition, Essentials(Allowed values- 2.5) edition, Enterprise edition. HsSecurityEncalgoScoreRc4 *float64 `json:"hs_security_encalgo_score_rc4,omitempty"` // Penalty for not enabling HSTS. Allowed values are 0-5. Allowed in Basic(Allowed values- 1.0) edition, Essentials(Allowed values- 1.0) edition, Enterprise edition. HsSecurityHstsPenalty *float64 `json:"hs_security_hsts_penalty,omitempty"` // Penalty for allowing non-PFS handshakes. Allowed values are 0-5. Allowed in Basic(Allowed values- 1.0) edition, Essentials(Allowed values- 1.0) edition, Enterprise edition. HsSecurityNonpfsPenalty *float64 `json:"hs_security_nonpfs_penalty,omitempty"` // Score assigned when OCSP Certificate Status is set to Revoked or Issuer Revoked. Allowed values are 0.0-5.0. Field introduced in 20.1.1. Allowed in Basic(Allowed values- 0.0) edition, Essentials(Allowed values- 0.0) edition, Enterprise edition. HsSecurityOcspRevokedScore *float64 `json:"hs_security_ocsp_revoked_score,omitempty"` // Deprecated. Allowed values are 0-5. Allowed in Basic(Allowed values- 1.0) edition, Essentials(Allowed values- 1.0) edition, Enterprise edition. HsSecuritySelfsignedcertPenalty *float64 `json:"hs_security_selfsignedcert_penalty,omitempty"` // Score assigned when supporting SSL3.0 encryption protocol. Allowed values are 0-5. Allowed in Basic(Allowed values- 3.5) edition, Essentials(Allowed values- 3.5) edition, Enterprise edition. HsSecuritySsl30Score *float64 `json:"hs_security_ssl30_score,omitempty"` // Score assigned when supporting TLS1.0 encryption protocol. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. HsSecurityTLS10Score *float64 `json:"hs_security_tls10_score,omitempty"` // Score assigned when supporting TLS1.1 encryption protocol. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. HsSecurityTLS11Score *float64 `json:"hs_security_tls11_score,omitempty"` // Score assigned when supporting TLS1.2 encryption protocol. Allowed values are 0-5. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. HsSecurityTLS12Score *float64 `json:"hs_security_tls12_score,omitempty"` // Score assigned when supporting TLS1.3 encryption protocol. Allowed values are 0-5. Field introduced in 18.2.6. Allowed in Basic(Allowed values- 5.0) edition, Essentials(Allowed values- 5.0) edition, Enterprise edition. // Read Only: true HsSecurityTLS13Score *float64 `json:"hs_security_tls13_score,omitempty"` // Penalty for allowing weak signature algorithm(s). Allowed values are 0-5. Allowed in Basic(Allowed values- 1.0) edition, Essentials(Allowed values- 1.0) edition, Enterprise edition. HsSecurityWeakSignatureAlgoPenalty *float64 `json:"hs_security_weak_signature_algo_penalty,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // The name of the analytics profile. // Required: true Name *string `json:"name"` // This flag sets the time duration of no live data traffic after which Virtual Service metrics processing is suspended. It is applicable only when enable_ondemand_metrics is set to false. Field introduced in 18.1.1. Unit is SECONDS. OndemandMetricsIDLETimeout *int32 `json:"ondemand_metrics_idle_timeout,omitempty"` // List of HTTP status code ranges to be excluded from being classified as an error. Ranges []*HttpstatusRange `json:"ranges,omitempty"` // Block of HTTP response codes to be excluded from being classified as an error. Enum options - AP_HTTP_RSP_4XX, AP_HTTP_RSP_5XX. RespCodeBlock []string `json:"resp_code_block,omitempty"` // Rules applied to the HTTP application log for filtering sensitive information. Field introduced in 17.2.10, 18.1.2. Allowed in Basic edition, Essentials edition, Enterprise edition. SensitiveLogProfile *SensitiveLogProfile `json:"sensitive_log_profile,omitempty"` // Maximum number of SIP messages added in logs for a SIP transaction. By default, this value is 20. Allowed values are 1-1000. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed in Basic(Allowed values- 20) edition, Essentials(Allowed values- 20) edition, Enterprise edition. SipLogDepth *int32 `json:"sip_log_depth,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the analytics profile. UUID *string `json:"uuid,omitempty"` }
AnalyticsProfile analytics profile swagger:model AnalyticsProfile
type AnalyticsProfileAPIResponse ¶
type AnalyticsProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*AnalyticsProfile `json:"results,omitempty"` }
AnalyticsProfileAPIResponse analytics profile Api response swagger:model AnalyticsProfileApiResponse
type AnomalyEventDetails ¶
type AnomalyEventDetails struct { // Placeholder for description of property deviation of obj type AnomalyEventDetails field type str type number Deviation *float64 `json:"deviation,omitempty"` // metric_id of AnomalyEventDetails. // Required: true MetricID *string `json:"metric_id"` // metric_timestamp of AnomalyEventDetails. // Required: true MetricTimestamp *string `json:"metric_timestamp"` // Deprecated. Enum options - EXPONENTIAL_MOVING_AVG, EXPONENTIAL_WEIGHTED_MOVING_AVG, HOLTWINTERS_AT_AS, HOLTWINTERS_AT_MS. Model *string `json:"model,omitempty"` // Enum options - EXPONENTIAL_MOVING_AVG, EXPONENTIAL_WEIGHTED_MOVING_AVG, HOLTWINTERS_AT_AS, HOLTWINTERS_AT_MS. Models []string `json:"models,omitempty"` // node_id of AnomalyEventDetails. NodeID *string `json:"node_id,omitempty"` // Enum options - METRICS_OBJ_TYPE_UNKNOWN. VSERVER_L4_SERVER. VSERVER_L4_CLIENT. VSERVER_L7_SERVER. VSERVER_L7_CLIENT. VM_METRICS_OBJ. SE_METRICS_OBJ. VSERVER_RUM. CONTROLLER_METRICS_OBJ. METRICS_COLLECTION. METRICS_RUM_PREAGG_BROWSER_OBJ. METRICS_RUM_PREAGG_COUNTRY_OBJ. METRICS_RUM_PREAGG_DEVTYPE_OBJ. METRICS_RUM_PREAGG_LANG_OBJ. METRICS_RUM_PREAGG_OS_OBJ. METRICS_RUM_PREAGG_URL_OBJ. METRICS_ANOMALY_OBJ. METRICS_HEALTHSCORE_OBJ. METRICS_RESOURCE_TIMING_BROWSER_OBJ. METRICS_RESOURCE_TIMING_OS_OBJ... ObjType *string `json:"obj_type,omitempty"` // pool_name of AnomalyEventDetails. PoolName *string `json:"pool_name,omitempty"` // Unique object identifier of pool. PoolUUID *string `json:"pool_uuid,omitempty"` // Enum options - ANZ_PRIORITY_HIGH, ANZ_PRIORITY_MEDIUM, ANZ_PRIORITY_LOW. // Required: true Priority *string `json:"priority"` // server of AnomalyEventDetails. Server *string `json:"server,omitempty"` // Placeholder for description of property value of obj type AnomalyEventDetails field type str type number // Required: true Value *float64 `json:"value"` }
AnomalyEventDetails anomaly event details swagger:model AnomalyEventDetails
type ApicAgentBridgeDomainVrfChange ¶
type ApicAgentBridgeDomainVrfChange struct { // bridge_domain of ApicAgentBridgeDomainVrfChange. BridgeDomain *string `json:"bridge_domain,omitempty"` // new_vrf of ApicAgentBridgeDomainVrfChange. NewVrf *string `json:"new_vrf,omitempty"` // old_vrf of ApicAgentBridgeDomainVrfChange. OldVrf *string `json:"old_vrf,omitempty"` // pool_list of ApicAgentBridgeDomainVrfChange. PoolList []string `json:"pool_list,omitempty"` // vs_list of ApicAgentBridgeDomainVrfChange. VsList []string `json:"vs_list,omitempty"` }
ApicAgentBridgeDomainVrfChange apic agent bridge domain vrf change swagger:model ApicAgentBridgeDomainVrfChange
type ApicAgentGenericEventDetails ¶
type ApicAgentGenericEventDetails struct { // contract_graphs of ApicAgentGenericEventDetails. ContractGraphs []string `json:"contract_graphs,omitempty"` // lif_cif_attachment of ApicAgentGenericEventDetails. LifCifAttachment []string `json:"lif_cif_attachment,omitempty"` // lifs of ApicAgentGenericEventDetails. Lifs []string `json:"lifs,omitempty"` // networks of ApicAgentGenericEventDetails. Networks []string `json:"networks,omitempty"` // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` // service_engine_vnics of ApicAgentGenericEventDetails. ServiceEngineVnics []string `json:"service_engine_vnics,omitempty"` // tenant_name of ApicAgentGenericEventDetails. TenantName *string `json:"tenant_name,omitempty"` // Unique object identifier of tenant. TenantUUID *string `json:"tenant_uuid,omitempty"` // vnic_network_attachment of ApicAgentGenericEventDetails. VnicNetworkAttachment []string `json:"vnic_network_attachment,omitempty"` // vs_name of ApicAgentGenericEventDetails. VsName *string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID *string `json:"vs_uuid,omitempty"` }
ApicAgentGenericEventDetails apic agent generic event details swagger:model ApicAgentGenericEventDetails
type ApicAgentVsNetworkError ¶
type ApicAgentVsNetworkError struct { // pool_name of ApicAgentVsNetworkError. PoolName *string `json:"pool_name,omitempty"` // pool_network of ApicAgentVsNetworkError. PoolNetwork *string `json:"pool_network,omitempty"` // vs_name of ApicAgentVsNetworkError. VsName *string `json:"vs_name,omitempty"` // vs_network of ApicAgentVsNetworkError. VsNetwork *string `json:"vs_network,omitempty"` }
ApicAgentVsNetworkError apic agent vs network error swagger:model ApicAgentVsNetworkError
type ApicVSPlacementReq ¶
type ApicVSPlacementReq struct { // graph of ApicVSPlacementReq. Graph *string `json:"graph,omitempty"` // Placeholder for description of property lifs of obj type ApicVSPlacementReq field type str type object Lifs []*Lif `json:"lifs,omitempty"` // Placeholder for description of property network_rel of obj type ApicVSPlacementReq field type str type object NetworkRel []*APICNetworkRel `json:"network_rel,omitempty"` // tenant_name of ApicVSPlacementReq. TenantName *string `json:"tenant_name,omitempty"` // vdev of ApicVSPlacementReq. Vdev *string `json:"vdev,omitempty"` // vgrp of ApicVSPlacementReq. Vgrp *string `json:"vgrp,omitempty"` }
ApicVSPlacementReq apic v s placement req swagger:model ApicVSPlacementReq
type AppCookiePersistenceProfile ¶
type AppCookiePersistenceProfile struct { // Key to use for cookie encryption. EncryptionKey *string `json:"encryption_key,omitempty"` // Header or cookie name for application cookie persistence. // Required: true PrstHdrName *string `json:"prst_hdr_name"` // The length of time after a client's connections have closed before expiring the client's persistence to a server. Allowed values are 1-720. Unit is MIN. Timeout *int32 `json:"timeout,omitempty"` }
AppCookiePersistenceProfile app cookie persistence profile swagger:model AppCookiePersistenceProfile
type AppHdr ¶
type AppHdr struct { // Enum options - SENSITIVE, INSENSITIVE. // Required: true HdrMatchCase *string `json:"hdr_match_case"` // hdr_name of AppHdr. // Required: true HdrName *string `json:"hdr_name"` // Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Basic(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Essentials(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Enterprise edition. // Required: true HdrStringOp *string `json:"hdr_string_op"` }
AppHdr app hdr swagger:model AppHdr
type AppInfo ¶
type AppInfo struct { // app_hdr_name of AppInfo. // Required: true AppHdrName *string `json:"app_hdr_name"` // app_hdr_value of AppInfo. // Required: true AppHdrValue *string `json:"app_hdr_value"` }
AppInfo app info swagger:model AppInfo
type AppLearningConfidenceOverride ¶
type AppLearningConfidenceOverride struct { // Confidence threshold for label CONFIDENCE_HIGH. Field introduced in 18.2.3. ConfidHighValue *int32 `json:"confid_high_value,omitempty"` // Confidence threshold for label CONFIDENCE_LOW. Field introduced in 18.2.3. ConfidLowValue *int32 `json:"confid_low_value,omitempty"` // Confidence threshold for label CONFIDENCE_PROBABLE. Field introduced in 18.2.3. ConfidProbableValue *int32 `json:"confid_probable_value,omitempty"` // Confidence threshold for label CONFIDENCE_VERY_HIGH. Field introduced in 18.2.3. ConfidVeryHighValue *int32 `json:"confid_very_high_value,omitempty"` }
AppLearningConfidenceOverride app learning confidence override swagger:model AppLearningConfidenceOverride
type AppLearningParams ¶
type AppLearningParams struct { // Learn the params per URI path. Field introduced in 18.2.3. EnablePerURILearning *bool `json:"enable_per_uri_learning,omitempty"` // Maximum number of params to learn for an application. Allowed values are 10-1000. Field introduced in 18.2.3. MaxParams *int32 `json:"max_params,omitempty"` // Maximum number of URI paths to learn for an application. Allowed values are 10-10000. Field introduced in 18.2.3. MaxUris *int32 `json:"max_uris,omitempty"` // Minimum number of occurances required for a Param to qualify for learning. Field introduced in 18.2.5. MinHitsToLearn *int64 `json:"min_hits_to_learn,omitempty"` // Percent of the requests subjected to Application learning. Allowed values are 1-100. Field introduced in 18.2.3. Unit is PERCENT. SamplingPercent *int32 `json:"sampling_percent,omitempty"` // Frequency with which SE publishes Application learning data to controller. Allowed values are 1-60. Field introduced in 18.2.3. Unit is MIN. UpdateInterval *int32 `json:"update_interval,omitempty"` }
AppLearningParams app learning params swagger:model AppLearningParams
type AppSignatureConfig ¶
type AppSignatureConfig struct { // Application Signature db sync interval in minutes. Allowed values are 60-10080. Field introduced in 20.1.4. Unit is MIN. Allowed in Basic(Allowed values- 60) edition, Essentials(Allowed values- 60) edition, Enterprise edition. Special default for Basic edition is 60, Essentials edition is 60, Enterprise is 1440. AppSignatureSyncInterval *int32 `json:"app_signature_sync_interval,omitempty"` }
AppSignatureConfig app signature config swagger:model AppSignatureConfig
type AppSignatureEventData ¶
type AppSignatureEventData struct { // Last Successful updated time of the AppSignature. Field introduced in 20.1.4. LastSuccessfulUpdatedTime *string `json:"last_successful_updated_time,omitempty"` // Reason for AppSignature transaction failure. Field introduced in 20.1.4. Reason *string `json:"reason,omitempty"` // Status of AppSignature transaction. Field introduced in 20.1.4. Status *string `json:"status,omitempty"` }
AppSignatureEventData app signature event data swagger:model AppSignatureEventData
type Application ¶
type Application struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // It is a reference to an object of type VirtualService. VirtualserviceRefs []string `json:"virtualservice_refs,omitempty"` }
Application application swagger:model Application
type ApplicationAPIResponse ¶
type ApplicationAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Application `json:"results,omitempty"` }
ApplicationAPIResponse application Api response swagger:model ApplicationApiResponse
type ApplicationLog ¶
type ApplicationLog struct { // Placeholder for description of property adf of obj type ApplicationLog field type str type boolean // Required: true Adf *bool `json:"adf"` // all_request_headers of ApplicationLog. AllRequestHeaders *string `json:"all_request_headers,omitempty"` // all_response_headers of ApplicationLog. AllResponseHeaders *string `json:"all_response_headers,omitempty"` // Unit is MILLISECONDS. AppResponseTime *int64 `json:"app_response_time,omitempty"` // Enum options - NOT_UPDATED, BY_CONTENT_REWRITE_PROFILE, BY_DATA_SCRIPT. Field introduced in 17.1.1. BodyUpdated *string `json:"body_updated,omitempty"` // Logs related to Bot detection. Field introduced in 21.1.1. BotManagementLog *BotManagementLog `json:"bot_management_log,omitempty"` // Cache fetch and store is disabled by the Datascript policies. Field introduced in 20.1.1. CacheDisabledByDs *bool `json:"cache_disabled_by_ds,omitempty"` // Placeholder for description of property cache_hit of obj type ApplicationLog field type str type boolean CacheHit *bool `json:"cache_hit,omitempty"` // Placeholder for description of property cacheable of obj type ApplicationLog field type str type boolean Cacheable *bool `json:"cacheable,omitempty"` // Byte stream of client cipher list sent on SSL_R_NO_SHARED_CIPHER error. Field introduced in 18.1.4, 18.2.1. CipherBytes *string `json:"cipher_bytes,omitempty"` // client_browser of ApplicationLog. ClientBrowser *string `json:"client_browser,omitempty"` // List of ciphers sent by client in TLS/SSL Client Hello. Only sent when TLS handshake fails due to no shared cipher. Field introduced in 18.1.4, 18.2.1. ClientCipherList *SSLCipherList `json:"client_cipher_list,omitempty"` // Number of client_dest_port. // Required: true ClientDestPort *int32 `json:"client_dest_port"` // client_device of ApplicationLog. ClientDevice *string `json:"client_device,omitempty"` // Enum options - INSIGHTS_DISABLED, NO_INSIGHTS_NOT_SAMPLED_COUNT, NO_INSIGHTS_NOT_SAMPLED_TYPE, NO_INSIGHTS_NOT_SAMPLED_SKIP_URI, NO_INSIGHTS_NOT_SAMPLED_URI_NOT_IN_LIST, NO_INSIGHTS_NOT_SAMPLED_CLIENT_IP_NOT_IN_RANGE, NO_INSIGHTS_NOT_SAMPLED_OTHER, ACTIVE_INSIGHTS_FAILED, ACTIVE_INSIGHTS_ENABLED, PASSIVE_INSIGHTS_ENABLED. ClientInsights *string `json:"client_insights,omitempty"` // Number of client_ip. // Required: true ClientIP *int32 `json:"client_ip"` // IPv6 address of the client. Field introduced in 18.1.1. ClientIp6 *string `json:"client_ip6,omitempty"` // client_location of ApplicationLog. ClientLocation *string `json:"client_location,omitempty"` // Name of the Client Log Filter applied. Field introduced in 18.1.5, 18.2.1. ClientLogFilterName *string `json:"client_log_filter_name,omitempty"` // client_os of ApplicationLog. ClientOs *string `json:"client_os,omitempty"` // Unit is MILLISECONDS. // Required: true ClientRtt *int32 `json:"client_rtt"` // Number of client_src_port. // Required: true ClientSrcPort *int32 `json:"client_src_port"` // Enum options - NO_COMPRESSION_DISABLED, NO_COMPRESSION_GZIP_CONTENT, NO_COMPRESSION_CONTENT_TYPE, NO_COMPRESSION_CUSTOM_FILTER, NO_COMPRESSION_AUTO_FILTER, NO_COMPRESSION_MIN_LENGTH, NO_COMPRESSION_CAN_BE_COMPRESSED, COMPRESSED. Compression *string `json:"compression,omitempty"` // Number of compression_percentage. CompressionPercentage *int32 `json:"compression_percentage,omitempty"` // Placeholder for description of property connection_error_info of obj type ApplicationLog field type str type object ConnectionErrorInfo *ConnErrorInfo `json:"connection_error_info,omitempty"` // Critical error encountered during request processing. Field introduced in 20.1.3. CriticalErrorEncountered *bool `json:"critical_error_encountered,omitempty"` // Unit is MILLISECONDS. DataTransferTime *int64 `json:"data_transfer_time,omitempty"` // Placeholder for description of property datascript_error_trace of obj type ApplicationLog field type str type object DatascriptErrorTrace *DataScriptErrorTrace `json:"datascript_error_trace,omitempty"` // Log created by the invocations of the DataScript api avi.vs.log(). DatascriptLog *string `json:"datascript_log,omitempty"` // etag of ApplicationLog. Etag *string `json:"etag,omitempty"` // The method called by the gRPC request. Field introduced in 20.1.1. GrpcMethodName *string `json:"grpc_method_name,omitempty"` // The service called by the gRPC request. Field introduced in 20.1.1. GrpcServiceName *string `json:"grpc_service_name,omitempty"` // GRPC response status sent in the GRPC trailer. Special values are -1- 'No GRPC status recevied even though client sent content-type as application/grpc.'. Field introduced in 20.1.1. GrpcStatus *int32 `json:"grpc_status,omitempty"` // The reason phrase corresponding to the gRPC status code. Enum options - GRPC_STATUS_CODE_OK, GRPC_STATUS_CODE_CANCELLED, GRPC_STATUS_CODE_UNKNOWN, GRPC_STATUS_CODE_INVALID_ARGUMENT, GRPC_STATUS_CODE_DEADLINE_EXCEEDED, GRPC_STATUS_CODE_NOT_FOUND, GRPC_STATUS_CODE_ALREADY_EXISTS, GRPC_STATUS_CODE_PERMISSION_DENIED, GRPC_STATUS_CODE_RESOURCE_EXHAUSTED, GRPC_STATUS_CODE_FAILED_PRECONDITION, GRPC_STATUS_CODE_STOPPED, GRPC_STATUS_CODE_OUT_OF_RANGE, GRPC_STATUS_CODE_UNIMPLEMENTED, GRPC_STATUS_CODE_INTERNAL, GRPC_STATUS_CODE_UNAVAILABLE, GRPC_STATUS_CODE_DATA_LOSS, GRPC_STATUS_CODE_UNAUTHENTICATED. Field introduced in 20.1.1. GrpcStatusReasonPhrase *string `json:"grpc_status_reason_phrase,omitempty"` // Response headers received from backend server. HeadersReceivedFromServer *string `json:"headers_received_from_server,omitempty"` // Request headers sent to backend server. HeadersSentToServer *string `json:"headers_sent_to_server,omitempty"` // host of ApplicationLog. Host *string `json:"host,omitempty"` // Stream identifier corresponding to an HTTP2 request. Field introduced in 18.1.2. Http2StreamID *int32 `json:"http2_stream_id,omitempty"` // http_request_policy_rule_name of ApplicationLog. HTTPRequestPolicyRuleName *string `json:"http_request_policy_rule_name,omitempty"` // http_response_policy_rule_name of ApplicationLog. HTTPResponsePolicyRuleName *string `json:"http_response_policy_rule_name,omitempty"` // http_security_policy_rule_name of ApplicationLog. HTTPSecurityPolicyRuleName *string `json:"http_security_policy_rule_name,omitempty"` // http_version of ApplicationLog. HTTPVersion *string `json:"http_version,omitempty"` // Log for the ICAP processing. Field introduced in 20.1.1. IcapLog *IcapLog `json:"icap_log,omitempty"` // Logs for the JWT Validation process. Field introduced in 20.1.3. JwtLog *JwtLog `json:"jwt_log,omitempty"` // Number of log_id. // Required: true LogID *int32 `json:"log_id"` // method of ApplicationLog. Method *string `json:"method,omitempty"` // microservice of ApplicationLog. Microservice *string `json:"microservice,omitempty"` // microservice_name of ApplicationLog. MicroserviceName *string `json:"microservice_name,omitempty"` // network_security_policy_rule_name of ApplicationLog. NetworkSecurityPolicyRuleName *string `json:"network_security_policy_rule_name,omitempty"` // NTLM auto-detection logs. Field introduced in 20.1.3. NtlmLog *NtlmLog `json:"ntlm_log,omitempty"` // OCSP Certificate Status response sent in the SSL/TLS connection handshake. Field introduced in 20.1.1. OcspStatusRespSent *bool `json:"ocsp_status_resp_sent,omitempty"` // Logs for HTTP Out-Of-Band Requests. Field introduced in 20.1.3. OobLog *OutOfBandRequestLog `json:"oob_log,omitempty"` // Logs for the PingAccess authentication process. Field introduced in 18.2.3. PaaLog *PaaLog `json:"paa_log,omitempty"` // Placeholder for description of property persistence_used of obj type ApplicationLog field type str type boolean PersistenceUsed *bool `json:"persistence_used,omitempty"` // Number of persistent_session_id. PersistentSessionID *int64 `json:"persistent_session_id,omitempty"` // pool of ApplicationLog. Pool *string `json:"pool,omitempty"` // pool_name of ApplicationLog. PoolName *string `json:"pool_name,omitempty"` // redirected_uri of ApplicationLog. RedirectedURI *string `json:"redirected_uri,omitempty"` // referer of ApplicationLog. Referer *string `json:"referer,omitempty"` // Number of report_timestamp. // Required: true ReportTimestamp *int64 `json:"report_timestamp"` // request_content_type of ApplicationLog. RequestContentType *string `json:"request_content_type,omitempty"` // Number of request_headers. RequestHeaders *int32 `json:"request_headers,omitempty"` // Unique HTTP Request ID . Field introduced in 17.2.4. RequestID *string `json:"request_id,omitempty"` // Unit is BYTES. RequestLength *int64 `json:"request_length,omitempty"` // Flag to indicate if request was served locally because the remote site was down. Field introduced in 17.2.5. RequestServedLocallyRemoteSiteDown *bool `json:"request_served_locally_remote_site_down,omitempty"` // Enum options - AVI_HTTP_REQUEST_STATE_CONN_ACCEPT, AVI_HTTP_REQUEST_STATE_WAITING_FOR_REQUEST, AVI_HTTP_REQUEST_STATE_SSL_HANDSHAKING, AVI_HTTP_REQUEST_STATE_PROCESSING_SPDY, AVI_HTTP_REQUEST_STATE_READ_CLIENT_REQ_LINE, AVI_HTTP_REQUEST_STATE_READ_CLIENT_REQ_HDR, AVI_HTTP_REQUEST_STATE_CONNECT_TO_UPSTREAM, AVI_HTTP_REQUEST_STATE_SEND_REQ_TO_UPSTREAM, AVI_HTTP_REQUEST_STATE_READ_RESP_HDR_FROM_UPSTREAM, AVI_HTTP_REQUEST_STATE_SEND_TO_CLIENT, AVI_HTTP_REQUEST_STATE_KEEPALIVE, AVI_HTTP_REQUEST_STATE_PROXY_UPGRADED_CONN, AVI_HTTP_REQUEST_STATE_CLOSING_REQUEST, AVI_HTTP_REQUEST_STATE_READ_FROM_UPSTREAM, AVI_HTTP_REQUEST_STATE_READ_PROXY_PROTOCOL, AVI_HTTP_REQUEST_STATE_READ_CLIENT_PIPELINE_REQ_LINE, AVI_HTTP_REQUEST_STATE_SSL_HANDSHAKE_TO_UPSTREAM, AVI_HTTP_REQUEST_STATE_WAITING_IN_CONNPOOL_CACHE, AVI_HTTP_REQUEST_STATE_SEND_RESPONSE_HEADER_TO_CLIENT, AVI_HTTP_REQUEST_STATE_SEND_RESPONSE_BODY_TO_CLIENT. RequestState *string `json:"request_state,omitempty"` // Number of response_code. ResponseCode *int32 `json:"response_code,omitempty"` // response_content_type of ApplicationLog. ResponseContentType *string `json:"response_content_type,omitempty"` // Number of response_headers. ResponseHeaders *int32 `json:"response_headers,omitempty"` // Unit is BYTES. ResponseLength *int64 `json:"response_length,omitempty"` // Unit is MILLISECONDS. ResponseTimeFirstByte *int64 `json:"response_time_first_byte,omitempty"` // Unit is MILLISECONDS. ResponseTimeLastByte *int64 `json:"response_time_last_byte,omitempty"` // rewritten_uri_path of ApplicationLog. RewrittenURIPath *string `json:"rewritten_uri_path,omitempty"` // rewritten_uri_query of ApplicationLog. RewrittenURIQuery *string `json:"rewritten_uri_query,omitempty"` // SAML authentication request is generated. Field introduced in 18.2.1. SamlAuthRequestGenerated *bool `json:"saml_auth_request_generated,omitempty"` // SAML authentication response is received. Field introduced in 18.2.1. SamlAuthResponseReceived *bool `json:"saml_auth_response_received,omitempty"` // SAML authentication session ID. Field introduced in 18.2.1. SamlAuthSessionID *int64 `json:"saml_auth_session_id,omitempty"` // SAML authentication is used. Field introduced in 18.2.1. SamlAuthenticationUsed *bool `json:"saml_authentication_used,omitempty"` // Logs for the SAML authentication/authorization process. Field introduced in 20.1.1. SamlLog *SamlLog `json:"saml_log,omitempty"` // SAML authentication session cookie is valid. Field introduced in 18.2.1. SamlSessionCookieValid *bool `json:"saml_session_cookie_valid,omitempty"` // Number of server_conn_src_ip. ServerConnSrcIP *int32 `json:"server_conn_src_ip,omitempty"` // IPv6 address used to connect to Server. Field introduced in 18.1.1. ServerConnSrcIp6 *string `json:"server_conn_src_ip6,omitempty"` // Flag to indicate if connection from the connection pool was reused. ServerConnectionReused *bool `json:"server_connection_reused,omitempty"` // Number of server_dest_port. ServerDestPort *int32 `json:"server_dest_port,omitempty"` // Number of server_ip. ServerIP *int32 `json:"server_ip,omitempty"` // IPv6 address of the Server. Field introduced in 18.1.1. ServerIp6 *string `json:"server_ip6,omitempty"` // server_name of ApplicationLog. ServerName *string `json:"server_name,omitempty"` // Number of server_response_code. ServerResponseCode *int32 `json:"server_response_code,omitempty"` // Unit is BYTES. ServerResponseLength *int64 `json:"server_response_length,omitempty"` // Unit is MILLISECONDS. ServerResponseTimeFirstByte *int64 `json:"server_response_time_first_byte,omitempty"` // Unit is MILLISECONDS. ServerResponseTimeLastByte *int64 `json:"server_response_time_last_byte,omitempty"` // Unit is MILLISECONDS. ServerRtt *int32 `json:"server_rtt,omitempty"` // server_side_redirect_uri of ApplicationLog. ServerSideRedirectURI *string `json:"server_side_redirect_uri,omitempty"` // Number of server_src_port. ServerSrcPort *int32 `json:"server_src_port,omitempty"` // SSL session id for the backend connection. ServerSslSessionID *string `json:"server_ssl_session_id,omitempty"` // Flag to indicate if SSL session was reused. ServerSslSessionReused *bool `json:"server_ssl_session_reused,omitempty"` // Number of servers tried during server reselect before the response is sent back. Field introduced in 18.2.2. ServersTried *int32 `json:"servers_tried,omitempty"` // service_engine of ApplicationLog. // Required: true ServiceEngine *string `json:"service_engine"` // Field set by datascript using avi.vs.set_session_id(). Field introduced in 21.1.1. SessionID *string `json:"session_id,omitempty"` // significance of ApplicationLog. Significance *string `json:"significance,omitempty"` // Number of significant. // Required: true Significant *int64 `json:"significant"` // List of enums which indicate why a log is significant. Enum options - ADF_CLIENT_CONN_SETUP_REFUSED, ADF_SERVER_CONN_SETUP_REFUSED, ADF_CLIENT_CONN_SETUP_TIMEDOUT, ADF_SERVER_CONN_SETUP_TIMEDOUT, ADF_CLIENT_CONN_SETUP_FAILED_INTERNAL, ADF_SERVER_CONN_SETUP_FAILED_INTERNAL, ADF_CLIENT_CONN_SETUP_FAILED_BAD_PACKET, ADF_UDP_CONN_SETUP_FAILED_INTERNAL, ADF_UDP_SERVER_CONN_SETUP_FAILED_INTERNAL, ADF_CLIENT_SENT_RESET, ADF_SERVER_SENT_RESET, ADF_CLIENT_CONN_TIMEDOUT, ADF_SERVER_CONN_TIMEDOUT, ADF_USER_DELETE_OPERATION, ADF_CLIENT_REQUEST_TIMEOUT, ADF_CLIENT_CONN_ABORTED, ADF_CLIENT_SSL_HANDSHAKE_FAILURE, ADF_CLIENT_CONN_FAILED, ADF_SERVER_CERTIFICATE_VERIFICATION_FAILED, ADF_SERVER_SIDE_SSL_HANDSHAKE_FAILED... SignificantLog []string `json:"significant_log,omitempty"` // Field introduced in 17.2.5. SniHostname *string `json:"sni_hostname,omitempty"` // spdy_version of ApplicationLog. SpdyVersion *string `json:"spdy_version,omitempty"` // ssl_cipher of ApplicationLog. SslCipher *string `json:"ssl_cipher,omitempty"` // ssl_session_id of ApplicationLog. SslSessionID *string `json:"ssl_session_id,omitempty"` // ssl_version of ApplicationLog. SslVersion *string `json:"ssl_version,omitempty"` // Unit is MILLISECONDS. TotalTime *int64 `json:"total_time,omitempty"` // Placeholder for description of property udf of obj type ApplicationLog field type str type boolean // Required: true Udf *bool `json:"udf"` // uri_path of ApplicationLog. URIPath *string `json:"uri_path,omitempty"` // uri_query of ApplicationLog. URIQuery *string `json:"uri_query,omitempty"` // user_agent of ApplicationLog. UserAgent *string `json:"user_agent,omitempty"` // user_id of ApplicationLog. UserID *string `json:"user_id,omitempty"` // Number of vcpu_id. // Required: true VcpuID *int32 `json:"vcpu_id"` // virtualservice of ApplicationLog. // Required: true Virtualservice *string `json:"virtualservice"` // Field introduced in 17.1.1. VsIP *int32 `json:"vs_ip,omitempty"` // Virtual IPv6 address of the VS. Field introduced in 18.1.1. VsIp6 *string `json:"vs_ip6,omitempty"` // Presence of waf_log indicates that atleast 1 WAF rule was hit for the transaction. Field introduced in 17.2.1. WafLog *WafLog `json:"waf_log,omitempty"` // xff of ApplicationLog. Xff *string `json:"xff,omitempty"` }
ApplicationLog application log swagger:model ApplicationLog
type ApplicationPersistenceProfile ¶
type ApplicationPersistenceProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Specifies the Application Cookie Persistence profile parameters. AppCookiePersistenceProfile *AppCookiePersistenceProfile `json:"app_cookie_persistence_profile,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Specifies the custom HTTP Header Persistence profile parameters. HdrPersistenceProfile *HdrPersistenceProfile `json:"hdr_persistence_profile,omitempty"` // Specifies the HTTP Cookie Persistence profile parameters. HTTPCookiePersistenceProfile *HTTPCookiePersistenceProfile `json:"http_cookie_persistence_profile,omitempty"` // Specifies the Client IP Persistence profile parameters. IPPersistenceProfile *IPPersistenceProfile `json:"ip_persistence_profile,omitempty"` // This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. . Field introduced in 17.1.3. IsFederated *bool `json:"is_federated,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // A user-friendly name for the persistence profile. // Required: true Name *string `json:"name"` // Method used to persist clients to the same server for a duration of time or a session. Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE. Allowed in Basic(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE) edition, Essentials(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE) edition, Enterprise edition. // Required: true PersistenceType *string `json:"persistence_type"` // Specifies behavior when a persistent server has been marked down by a health monitor. Enum options - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER. Allowed in Basic(Allowed values- HM_DOWN_PICK_NEW_SERVER) edition, Essentials(Allowed values- HM_DOWN_PICK_NEW_SERVER) edition, Enterprise edition. ServerHmDownRecovery *string `json:"server_hm_down_recovery,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the persistence profile. UUID *string `json:"uuid,omitempty"` }
ApplicationPersistenceProfile application persistence profile swagger:model ApplicationPersistenceProfile
type ApplicationPersistenceProfileAPIResponse ¶
type ApplicationPersistenceProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ApplicationPersistenceProfile `json:"results,omitempty"` }
ApplicationPersistenceProfileAPIResponse application persistence profile Api response swagger:model ApplicationPersistenceProfileApiResponse
type ApplicationProfile ¶
type ApplicationProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Checksum of application profiles. Internally set by cloud connector. Field introduced in 17.2.14, 18.1.5, 18.2.1. CloudConfigCksum *string `json:"cloud_config_cksum,omitempty"` // Name of the application profile creator. Field introduced in 17.2.14, 18.1.5, 18.2.1. CreatedBy *string `json:"created_by,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Specifies various DNS service related controls for virtual service. DNSServiceProfile *DNSServiceApplicationProfile `json:"dns_service_profile,omitempty"` // Specifies various security related controls for virtual service. DosRlProfile *DosRateLimitProfile `json:"dos_rl_profile,omitempty"` // Specifies the HTTP application proxy profile parameters. HTTPProfile *HTTPApplicationProfile `json:"http_profile,omitempty"` // The name of the application profile. // Required: true Name *string `json:"name"` // Specifies if client IP needs to be preserved for backend connection. Not compatible with Connection Multiplexing. PreserveClientIP *bool `json:"preserve_client_ip,omitempty"` // Specifies if we need to preserve client port while preserving client IP for backend connections. Field introduced in 17.2.7. PreserveClientPort *bool `json:"preserve_client_port,omitempty"` // Specifies if destination IP and port needs to be preserved for backend connection. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. PreserveDestIPPort *bool `json:"preserve_dest_ip_port,omitempty"` // Specifies various SIP service related controls for virtual service. Field introduced in 17.2.8, 18.1.3, 18.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. SipServiceProfile *SipServiceApplicationProfile `json:"sip_service_profile,omitempty"` // Specifies the TCP application proxy profile parameters. TCPAppProfile *TCPApplicationProfile `json:"tcp_app_profile,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Specifies which application layer proxy is enabled for the virtual service. Enum options - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS, APPLICATION_PROFILE_TYPE_SSL, APPLICATION_PROFILE_TYPE_SIP. Allowed in Basic(Allowed values- APPLICATION_PROFILE_TYPE_L4,APPLICATION_PROFILE_TYPE_HTTP) edition, Essentials(Allowed values- APPLICATION_PROFILE_TYPE_L4) edition, Enterprise edition. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the application profile. UUID *string `json:"uuid,omitempty"` }
ApplicationProfile application profile swagger:model ApplicationProfile
type ApplicationProfileAPIResponse ¶
type ApplicationProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ApplicationProfile `json:"results,omitempty"` }
ApplicationProfileAPIResponse application profile Api response swagger:model ApplicationProfileApiResponse
type ArpTableFilter ¶
type ArpTableFilter struct { // IP address. IPAddress *IPAddr `json:"ip_address,omitempty"` }
ArpTableFilter arp table filter swagger:model ArpTableFilter
type AttackMetaData ¶
type AttackMetaData struct { // ip of AttackMetaData. IP *string `json:"ip,omitempty"` // Number of max_resp_time. MaxRespTime *int32 `json:"max_resp_time,omitempty"` // url of AttackMetaData. URL *string `json:"url,omitempty"` }
AttackMetaData attack meta data swagger:model AttackMetaData
type AttackMetaDataAPIResponse ¶
type AttackMetaDataAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*AttackMetaData `json:"results,omitempty"` }
AttackMetaDataAPIResponse attack meta data Api response swagger:model AttackMetaDataApiResponse
type AttackMitigationAction ¶
type AttackMitigationAction struct { // Deny the attack packets further processing and drop them. Field introduced in 18.2.1. Deny *bool `json:"deny,omitempty"` }
AttackMitigationAction attack mitigation action swagger:model AttackMitigationAction
type AuditComplianceEventInfo ¶
type AuditComplianceEventInfo struct { // Detailed report of the audit event. Field introduced in 20.1.3. DetailedReason *string `json:"detailed_reason,omitempty"` // Information identifying physical location for audit event (e.g. Santa Clara (USA), Bengaluru (India)). Field introduced in 20.1.3. Location *string `json:"location,omitempty"` // Node on which crash is generated. Field introduced in 20.1.4. Node *string `json:"node,omitempty"` // Crashed core process name. Field introduced in 20.1.4. ProcessName *string `json:"process_name,omitempty"` // Protocol used for communication to the external entity. Enum options - SSH1_0, TLS1_2, HTTPS1_0, HTTP_PLAIN_TEXT, HTTPS_INSECURE, SSH2_0. Field introduced in 20.1.3. // Required: true Protocol *string `json:"protocol"` // Summarized failure of the transaction (e.g. Invalid request, expired certificate). Field introduced in 20.1.3. // Required: true Result *string `json:"result"` // Subjects of audit event. Field introduced in 20.1.3. Minimum of 1 items required. Subjects []*ACSubjectInfo `json:"subjects,omitempty"` // Type of audit event. Enum options - AUDIT_INVALID_CREDENTIALS, AUDIT_NAME_RESOLUTION_ERROR, AUDIT_DIAL_X509_ERROR, AUDIT_CORE_GENERATED, AUDIT_SECURE_KEY_EXCHANGE_BAD_REQUEST_FORMAT, AUDIT_SECURE_KEY_EXCHANGE_BAD_CLIENT_TYPE, AUDIT_SECURE_KEY_EXCHANGE_FIELD_NOT_FOUND, AUDIT_SECURE_KEY_EXCHANGE_BAD_FIELD_VALUE, AUDIT_SECURE_KEY_EXCHANGE_INVALID_AUTHORIZATION, AUDIT_SECURE_KEY_EXCHANGE_INTERNAL_ERROR, AUDIT_SECURE_KEY_EXCHANGE_CERTIFICATE_VERIFY_ERROR, AUDIT_SECURE_KEY_EXCHANGE_RESPONSE_ERROR. Field introduced in 20.1.3. // Required: true Type *string `json:"type"` // List of users (username etc) related to the audit event. Field introduced in 20.1.3. Minimum of 1 items required. UserIdentities []*ACUserIdentity `json:"user_identities,omitempty"` }
AuditComplianceEventInfo audit compliance event info swagger:model AuditComplianceEventInfo
type AuthAttributeMatch ¶
type AuthAttributeMatch struct { // Attribute name whose values will be looked up in the access lists. Field introduced in 18.2.5. // Required: true AttributeName *string `json:"attribute_name"` // Attribute Values used to determine access when authentication applies. Field introduced in 18.2.5. Allowed in Basic edition, Essentials edition, Enterprise edition. // Required: true AttributeValueList *StringMatch `json:"attribute_value_list"` }
AuthAttributeMatch auth attribute match swagger:model AuthAttributeMatch
type AuthMappingRule ¶
type AuthMappingRule struct { // Assignment rule for the Object Access Policy. Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. Field introduced in 18.2.7, 20.1.1. AssignPolicy *string `json:"assign_policy,omitempty"` // Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. AssignRole *string `json:"assign_role,omitempty"` // Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. AssignTenant *string `json:"assign_tenant,omitempty"` // Assignment rule for the User Account Profile. Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX, ASSIGN_MATCHING_ATTRIBUTE_REGEX. Field introduced in 20.1.3. AssignUserprofile *string `json:"assign_userprofile,omitempty"` // Placeholder for description of property attribute_match of obj type AuthMappingRule field type str type object AttributeMatch *AuthMatchAttribute `json:"attribute_match,omitempty"` // Placeholder for description of property group_match of obj type AuthMappingRule field type str type object GroupMatch *AuthMatchGroupMembership `json:"group_match,omitempty"` // Number of index. // Required: true Index *int32 `json:"index"` // Placeholder for description of property is_superuser of obj type AuthMappingRule field type str type boolean IsSuperuser *bool `json:"is_superuser,omitempty"` // Object Access Policies to assign to user on successful match. It is a reference to an object of type ObjectAccessPolicy. Field deprecated in 20.1.2. Field introduced in 18.2.7, 20.1.1. ObjectAccessPolicyRefs []string `json:"object_access_policy_refs,omitempty"` // Attribute name for Object Access Policy assignment. Field introduced in 18.2.7, 20.1.1. PolicyAttributeName *string `json:"policy_attribute_name,omitempty"` // role_attribute_name of AuthMappingRule. RoleAttributeName *string `json:"role_attribute_name,omitempty"` // It is a reference to an object of type Role. RoleRefs []string `json:"role_refs,omitempty"` // tenant_attribute_name of AuthMappingRule. TenantAttributeName *string `json:"tenant_attribute_name,omitempty"` // It is a reference to an object of type Tenant. TenantRefs []string `json:"tenant_refs,omitempty"` // Attribute name for User Account Profile assignment. Field introduced in 20.1.3. UserprofileAttributeName *string `json:"userprofile_attribute_name,omitempty"` // User Account Profile to assign to user on successful match. It is a reference to an object of type UserAccountProfile. Field introduced in 20.1.3. UserprofileRef *string `json:"userprofile_ref,omitempty"` }
AuthMappingRule auth mapping rule swagger:model AuthMappingRule
type AuthMatchAttribute ¶
type AuthMatchAttribute struct { // rule match criteria. Enum options - AUTH_MATCH_CONTAINS, AUTH_MATCH_DOES_NOT_CONTAIN, AUTH_MATCH_REGEX. // Required: true Criteria *string `json:"criteria"` // Name of the object. Name *string `json:"name,omitempty"` // values of AuthMatchAttribute. Values []string `json:"values,omitempty"` }
AuthMatchAttribute auth match attribute swagger:model AuthMatchAttribute
type AuthMatchGroupMembership ¶
type AuthMatchGroupMembership struct { // rule match criteria. Enum options - AUTH_MATCH_CONTAINS, AUTH_MATCH_DOES_NOT_CONTAIN, AUTH_MATCH_REGEX. // Required: true Criteria *string `json:"criteria"` // groups of AuthMatchGroupMembership. Groups []string `json:"groups,omitempty"` }
AuthMatchGroupMembership auth match group membership swagger:model AuthMatchGroupMembership
type AuthProfile ¶
type AuthProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // HTTP user authentication params. HTTP *AuthProfileHTTPClientParams `json:"http,omitempty"` // JWTServerProfile to be used for authentication. It is a reference to an object of type JWTServerProfile. Field introduced in 20.1.3. JwtProfileRef *string `json:"jwt_profile_ref,omitempty"` // LDAP server and directory settings. Ldap *LdapAuthSettings `json:"ldap,omitempty"` // Name of the Auth Profile. // Required: true Name *string `json:"name"` // PingAccessAgent uuid. It is a reference to an object of type PingAccessAgent. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. PaAgentRef *string `json:"pa_agent_ref,omitempty"` // SAML settings. Field introduced in 17.2.3. Saml *SamlSettings `json:"saml,omitempty"` // TACACS+ settings. TacacsPlus *TacacsPlusAuthSettings `json:"tacacs_plus,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Type of the Auth Profile. Enum options - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS, AUTH_PROFILE_JWT. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the Auth Profile. UUID *string `json:"uuid,omitempty"` }
AuthProfile auth profile swagger:model AuthProfile
type AuthProfileAPIResponse ¶
type AuthProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*AuthProfile `json:"results,omitempty"` }
AuthProfileAPIResponse auth profile Api response swagger:model AuthProfileApiResponse
type AuthProfileHTTPClientParams ¶
type AuthProfileHTTPClientParams struct { // The max allowed length of time a clients authentication is cached. Allowed values are 1-30. Unit is SEC. CacheExpirationTime *int32 `json:"cache_expiration_time,omitempty"` // Group member entries contain full DNs instead of just user id attribute values. This should now be configured using the LdapDirectorySettings field instead. Field deprecated in 18.2.1. GroupMemberIsFullDn *bool `json:"group_member_is_full_dn,omitempty"` // Insert an HTTP header. This field is used to define the header name. The value of the header is set to the client's HTTP Auth user ID. RequestHeader *string `json:"request_header,omitempty"` // A user should be a member of these groups. Each group is defined by the DN. For example, CN=testgroup,OU=groups,dc=example,dc=avinetworks,DC=com. RequireUserGroups []string `json:"require_user_groups,omitempty"` }
AuthProfileHTTPClientParams auth profile HTTP client params swagger:model AuthProfileHTTPClientParams
type AuthTacacsPlusAttributeValuePair ¶
type AuthTacacsPlusAttributeValuePair struct { // mandatory. Mandatory *bool `json:"mandatory,omitempty"` // attribute name. Name *string `json:"name,omitempty"` // attribute value. Value *string `json:"value,omitempty"` }
AuthTacacsPlusAttributeValuePair auth tacacs plus attribute value pair swagger:model AuthTacacsPlusAttributeValuePair
type AuthenticationAction ¶
type AuthenticationAction struct { // Authentication Action to be taken for a matched Rule. Enum options - SKIP_AUTHENTICATION, USE_DEFAULT_AUTHENTICATION. Field introduced in 18.2.5. // Required: true Type *string `json:"type"` }
AuthenticationAction authentication action swagger:model AuthenticationAction
type AuthenticationMatch ¶
type AuthenticationMatch struct { // Configure client ip addresses. Field introduced in 18.2.5. ClientIP *IPAddrMatch `json:"client_ip,omitempty"` // Configure the host header. Field introduced in 18.2.5. HostHdr *HostHdrMatch `json:"host_hdr,omitempty"` // Configure request paths. Field introduced in 18.2.5. Path *PathMatch `json:"path,omitempty"` }
AuthenticationMatch authentication match swagger:model AuthenticationMatch
type AuthenticationPolicy ¶
type AuthenticationPolicy struct { // Auth Profile to use for validating users. It is a reference to an object of type AuthProfile. Field deprecated in 18.2.3. Field introduced in 18.2.1. AuthProfileRef *string `json:"auth_profile_ref,omitempty"` // Add rules to apply auth profile to specific targets. Field introduced in 18.2.5. AuthnRules []*AuthenticationRule `json:"authn_rules,omitempty"` // HTTP cookie name for authenticated session. Field deprecated in 18.2.3. Field introduced in 18.2.1. CookieName *string `json:"cookie_name,omitempty"` // Cookie timeout in minutes. Allowed values are 1-1440. Field deprecated in 18.2.3. Field introduced in 18.2.1. Unit is MIN. CookieTimeout *int32 `json:"cookie_timeout,omitempty"` // Auth Profile to use for validating users. It is a reference to an object of type AuthProfile. Field introduced in 18.2.3. // Required: true DefaultAuthProfileRef *string `json:"default_auth_profile_ref"` // Globally unique entityID for this node. Entity ID on the IDP should match this. Field deprecated in 18.2.3. Field introduced in 18.2.1. EntityID *string `json:"entity_id,omitempty"` // Key to generate the cookie. Field deprecated in 18.2.3. Field introduced in 18.2.1. Key []*HTTPCookiePersistenceKey `json:"key,omitempty"` // Single Signon URL to be programmed on the IDP. Field deprecated in 18.2.3. Field introduced in 18.2.1. SingleSignonURL *string `json:"single_signon_url,omitempty"` // SAML SP metadata. Field deprecated in 18.2.3. Field introduced in 18.2.1. // Read Only: true SpMetadata *string `json:"sp_metadata,omitempty"` }
AuthenticationPolicy authentication policy swagger:model AuthenticationPolicy
type AuthenticationRule ¶
type AuthenticationRule struct { // Enable or disable authentication for matched targets. Field introduced in 18.2.5. Action *AuthenticationAction `json:"action,omitempty"` // Enable or disable the rule. Field introduced in 18.2.5. // Required: true Enable *bool `json:"enable"` // Index of the rule. Field introduced in 18.2.5. // Required: true Index *int32 `json:"index"` // Add match criteria to the rule. Field introduced in 18.2.5. Allowed in Basic edition, Essentials edition, Enterprise edition. Match *AuthenticationMatch `json:"match,omitempty"` // Name of the rule. Field introduced in 18.2.5. // Required: true Name *string `json:"name"` }
AuthenticationRule authentication rule swagger:model AuthenticationRule
type AuthnRuleMatch ¶
type AuthnRuleMatch struct { // Name of the executed Authentication rule Action. Enum options - SKIP_AUTHENTICATION, USE_DEFAULT_AUTHENTICATION. Field introduced in 20.1.3. RuleAction *string `json:"rule_action,omitempty"` // Name of the matched Authentication rule. Field introduced in 20.1.3. RuleName *string `json:"rule_name,omitempty"` }
AuthnRuleMatch authn rule match swagger:model AuthnRuleMatch
type AuthorizationAction ¶
type AuthorizationAction struct { // HTTP status code to use for local response when an policy rule is matched. Enum options - HTTP_RESPONSE_STATUS_CODE_401, HTTP_RESPONSE_STATUS_CODE_403. Field introduced in 18.2.5. StatusCode *string `json:"status_code,omitempty"` // Defines the action taken when an authorization policy rule is matched. By default, access is allowed to the requested resource. Enum options - ALLOW_ACCESS, CLOSE_CONNECTION, HTTP_LOCAL_RESPONSE. Field introduced in 18.2.5. Type *string `json:"type,omitempty"` }
AuthorizationAction authorization action swagger:model AuthorizationAction
type AuthorizationMatch ¶
type AuthorizationMatch struct { // Access Token claims to be matched. Field introduced in 20.1.3. AccessToken *JWTMatch `json:"access_token,omitempty"` // Attributes whose values need to be matched . Field introduced in 18.2.5. Allowed in Basic edition, Essentials edition, Enterprise edition. AttrMatches []*AuthAttributeMatch `json:"attr_matches,omitempty"` // Host header value to be matched. Field introduced in 18.2.5. HostHdr *HostHdrMatch `json:"host_hdr,omitempty"` // HTTP methods to be matched. Field introduced in 18.2.5. Method *MethodMatch `json:"method,omitempty"` // Paths/URLs to be matched. Field introduced in 18.2.5. Path *PathMatch `json:"path,omitempty"` }
AuthorizationMatch authorization match swagger:model AuthorizationMatch
type AuthorizationPolicy ¶
type AuthorizationPolicy struct { // Authorization Policy Rules. Field introduced in 18.2.5. AuthzRules []*AuthorizationRule `json:"authz_rules,omitempty"` }
AuthorizationPolicy authorization policy swagger:model AuthorizationPolicy
type AuthorizationRule ¶
type AuthorizationRule struct { // Authorization action when rule is matched. Field introduced in 18.2.5. // Required: true Action *AuthorizationAction `json:"action"` // Enable or disable the rule. Field introduced in 18.2.5. // Required: true Enable *bool `json:"enable"` // Index of the Authorization Policy rule. Field introduced in 18.2.5. // Required: true Index *int32 `json:"index"` // Authorization match criteria for the rule. Field introduced in 18.2.5. Allowed in Basic edition, Essentials edition, Enterprise edition. // Required: true Match *AuthorizationMatch `json:"match"` // Name of the rule. Field introduced in 18.2.5. // Required: true Name *string `json:"name"` }
AuthorizationRule authorization rule swagger:model AuthorizationRule
type AuthzRuleMatch ¶
type AuthzRuleMatch struct { // Name of the executed Authorization rule Action. Enum options - ALLOW_ACCESS, CLOSE_CONNECTION, HTTP_LOCAL_RESPONSE. Field introduced in 20.1.3. RuleAction *string `json:"rule_action,omitempty"` // Name of the matched Authorization rule. Field introduced in 20.1.3. RuleName *string `json:"rule_name,omitempty"` }
AuthzRuleMatch authz rule match swagger:model AuthzRuleMatch
type AutoScaleLaunchConfig ¶
type AutoScaleLaunchConfig struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Unique ID of the Amazon Machine Image (AMI) or OpenStack VM ID. ImageID *string `json:"image_id,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Placeholder for description of property mesos of obj type AutoScaleLaunchConfig field type str type object Mesos *AutoScaleMesosSettings `json:"mesos,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Placeholder for description of property openstack of obj type AutoScaleLaunchConfig field type str type object Openstack *AutoScaleOpenStackSettings `json:"openstack,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // If set to True, ServerAutoscalePolicy will use the autoscaling group (external_autoscaling_groups) from Pool to perform scale up and scale down. Pool should have single autoscaling group configured. Field introduced in 17.2.3. UseExternalAsg *bool `json:"use_external_asg,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
AutoScaleLaunchConfig auto scale launch config swagger:model AutoScaleLaunchConfig
type AutoScaleLaunchConfigAPIResponse ¶
type AutoScaleLaunchConfigAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*AutoScaleLaunchConfig `json:"results,omitempty"` }
AutoScaleLaunchConfigAPIResponse auto scale launch config Api response swagger:model AutoScaleLaunchConfigApiResponse
type AutoScaleMesosSettings ¶
type AutoScaleMesosSettings struct { // Apply scaleout even when there are deployments inprogress. Force *bool `json:"force,omitempty"` }
AutoScaleMesosSettings auto scale mesos settings swagger:model AutoScaleMesosSettings
type AutoScaleMgrDebugFilter ¶
type AutoScaleMgrDebugFilter struct { // Enable aws autoscale integration. This is an alpha feature. Field introduced in 17.1.1. EnableAwsAutoscaleIntegration *bool `json:"enable_aws_autoscale_integration,omitempty"` // period of running intelligent autoscale check. IntelligentAutoscalePeriod *int32 `json:"intelligent_autoscale_period,omitempty"` // uuid of the Pool. It is a reference to an object of type Pool. PoolRef *string `json:"pool_ref,omitempty"` }
AutoScaleMgrDebugFilter auto scale mgr debug filter swagger:model AutoScaleMgrDebugFilter
type AutoScaleOpenStackSettings ¶
type AutoScaleOpenStackSettings struct { // Avi Controller will use this URL to scale downthe pool. Cloud connector will automatically update the membership. This is an alpha feature. Field introduced in 17.1.1. HeatScaleDownURL *string `json:"heat_scale_down_url,omitempty"` // Avi Controller will use this URL to scale upthe pool. Cloud connector will automatically update the membership. This is an alpha feature. Field introduced in 17.1.1. HeatScaleUpURL *string `json:"heat_scale_up_url,omitempty"` }
AutoScaleOpenStackSettings auto scale open stack settings swagger:model AutoScaleOpenStackSettings
type AvailabilityZone ¶
type AvailabilityZone struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Availability zone belongs to cloud. It is a reference to an object of type Cloud. Field introduced in 20.1.1. CloudRef *string `json:"cloud_ref,omitempty"` // Availabilty zone where VCenter list belongs to. Field introduced in 20.1.1. // Required: true Name *string `json:"name"` // Availabilityzone belongs to tenant. It is a reference to an object of type Tenant. Field introduced in 20.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Availability zone config UUID. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` // Group of VCenter list belong to availabilty zone. It is a reference to an object of type VCenterServer. Field introduced in 20.1.1. Minimum of 1 items required. VcenterRefs []string `json:"vcenter_refs,omitempty"` }
AvailabilityZone availability zone swagger:model AvailabilityZone
type AvailabilityZoneAPIResponse ¶
type AvailabilityZoneAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*AvailabilityZone `json:"results,omitempty"` }
AvailabilityZoneAPIResponse availability zone Api response swagger:model AvailabilityZoneApiResponse
type AvgUptimeChangeDetails ¶
type AvgUptimeChangeDetails struct { // Placeholder for description of property current_value of obj type AvgUptimeChangeDetails field type str type number CurrentValue *float64 `json:"current_value,omitempty"` // metric_id of AvgUptimeChangeDetails. MetricID *string `json:"metric_id,omitempty"` // metric_name of AvgUptimeChangeDetails. MetricName *string `json:"metric_name,omitempty"` // resource_str of AvgUptimeChangeDetails. ResourceStr *string `json:"resource_str,omitempty"` // Placeholder for description of property threshold of obj type AvgUptimeChangeDetails field type str type number Threshold *float64 `json:"threshold,omitempty"` }
AvgUptimeChangeDetails avg uptime change details swagger:model AvgUptimeChangeDetails
type AwsConfiguration ¶
type AwsConfiguration struct { // AWS access key ID. AccessKeyID *string `json:"access_key_id,omitempty"` // Time interval between periodic polling of all Auto Scaling Groups. Allowed values are 60-1800. Field introduced in 17.1.3. Unit is SEC. AsgPollInterval *int32 `json:"asg_poll_interval,omitempty"` // EBS encryption mode and the master key to be used for encrypting SE AMI, Volumes, and Snapshots. Field introduced in 17.2.3. EbsEncryption *AwsEncryption `json:"ebs_encryption,omitempty"` // Free unused elastic IP addresses. FreeElasticips *bool `json:"free_elasticips,omitempty"` // IAM assume role for cross-account access. IamAssumeRole *string `json:"iam_assume_role,omitempty"` // If enabled and the virtual service is not floating ip capable, vip will be published to both private and public zones. Field introduced in 17.2.10. PublishVipToPublicZone *bool `json:"publish_vip_to_public_zone,omitempty"` // AWS region. Region *string `json:"region,omitempty"` // If enabled, create/update DNS entries in Amazon Route 53 zones. Route53Integration *bool `json:"route53_integration,omitempty"` // S3 encryption mode and the master key to be used for encrypting S3 buckets during SE AMI upload. Only SSE-KMS mode is supported. Field introduced in 17.2.3. S3Encryption *AwsEncryption `json:"s3_encryption,omitempty"` // AWS secret access key. SecretAccessKey *string `json:"secret_access_key,omitempty"` // Server Side Encryption to be used for encrypting SQS Queues. Field introduced in 17.2.8. SqsEncryption *AwsEncryption `json:"sqs_encryption,omitempty"` // Default TTL for all records. Allowed values are 1-172800. Field introduced in 17.1.3. Unit is SEC. TTL *int32 `json:"ttl,omitempty"` // Use IAM roles instead of access and secret key. UseIamRoles *bool `json:"use_iam_roles,omitempty"` // Use SNS/SQS based notifications for monitoring Auto Scaling Groups. Field introduced in 17.1.3. UseSnsSqs *bool `json:"use_sns_sqs,omitempty"` // VPC name. Vpc *string `json:"vpc,omitempty"` // VPC ID. // Required: true VpcID *string `json:"vpc_id"` // If enabled, program SE security group with ingress rule to allow SSH (port 22) access from 0.0.0.0/0. Field deprecated in 17.1.5. Field introduced in 17.1.3. WildcardAccess *bool `json:"wildcard_access,omitempty"` // Placeholder for description of property zones of obj type AwsConfiguration field type str type object Zones []*AwsZoneConfig `json:"zones,omitempty"` }
AwsConfiguration aws configuration swagger:model AwsConfiguration
type AwsEncryption ¶
type AwsEncryption struct { // AWS KMS ARN ID of the master key for encryption. Field introduced in 17.2.3. MasterKey *string `json:"master_key,omitempty"` // AWS encryption mode. Enum options - AWS_ENCRYPTION_MODE_NONE, AWS_ENCRYPTION_MODE_SSE_KMS. Field introduced in 17.2.3. Mode *string `json:"mode,omitempty"` }
AwsEncryption aws encryption swagger:model AwsEncryption
type AwsZoneConfig ¶
type AwsZoneConfig struct { // Availability zone. // Required: true AvailabilityZone *string `json:"availability_zone"` // Name or CIDR of the network in the Availability Zone that will be used as management network. // Required: true MgmtNetworkName *string `json:"mgmt_network_name"` // UUID of the network in the Availability Zone that will be used as management network. MgmtNetworkUUID *string `json:"mgmt_network_uuid,omitempty"` }
AwsZoneConfig aws zone config swagger:model AwsZoneConfig
type AwsZoneNetwork ¶
type AwsZoneNetwork struct { // Availability zone. Field introduced in 17.1.3. // Required: true AvailabilityZone *string `json:"availability_zone"` // Usable networks for Virtual IP. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation. Field introduced in 17.1.3. UsableNetworkUuids []string `json:"usable_network_uuids,omitempty"` }
AwsZoneNetwork aws zone network swagger:model AwsZoneNetwork
type AzureClusterInfo ¶
type AzureClusterInfo struct { // It is a reference to an object of type CloudConnectorUser. Field introduced in 17.2.5. // Required: true CloudCredentialRef *string `json:"cloud_credential_ref"` // Field introduced in 17.2.5. // Required: true SubscriptionID *string `json:"subscription_id"` }
AzureClusterInfo azure cluster info swagger:model AzureClusterInfo
type AzureConfiguration ¶
type AzureConfiguration struct { // Availability zones to be used in Azure. Field introduced in 17.2.5. AvailabilityZones []string `json:"availability_zones,omitempty"` // Credentials to access azure cloud. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.2.1. CloudCredentialsRef *string `json:"cloud_credentials_ref,omitempty"` // Disks Encryption Set resource-id (des_id) to encrypt se image and managed disk using customer-managed-keys. Field introduced in 20.1.1. DesID *string `json:"des_id,omitempty"` // Azure location where this cloud will be located. Field introduced in 17.2.1. Location *string `json:"location,omitempty"` // Azure virtual network and subnet information. Field introduced in 17.2.1. Minimum of 1 items required. Maximum of 1 items allowed. NetworkInfo []*AzureNetworkInfo `json:"network_info,omitempty"` // Azure resource group dedicated for Avi Controller. Avi Controller will create all its resources in this resource group. Field introduced in 17.2.1. ResourceGroup *string `json:"resource_group,omitempty"` // Subscription Id for the Azure subscription. Field introduced in 17.2.1. SubscriptionID *string `json:"subscription_id,omitempty"` // Azure is the DNS provider. Field introduced in 17.2.1. UseAzureDNS *bool `json:"use_azure_dns,omitempty"` // Use Azure's enhanced HA features. This needs a public IP to be associated with the VIP. . Field introduced in 17.2.1. UseEnhancedHa *bool `json:"use_enhanced_ha,omitempty"` // Use Azure managed disks for SE storage. Field introduced in 17.2.2. UseManagedDisks *bool `json:"use_managed_disks,omitempty"` // Use Standard SKU Azure Load Balancer. By default Basic SKU Load Balancer is used. Field introduced in 17.2.7. UseStandardAlb *bool `json:"use_standard_alb,omitempty"` }
AzureConfiguration azure configuration swagger:model AzureConfiguration
type AzureInfo ¶
type AzureInfo struct { // Name of the availability set of which the VM is a part of. Field introduced in 17.2.1. AvailabilitySet *string `json:"availability_set,omitempty"` // Fault domain within the availability set the VM is a part of. Field introduced in 17.2.1. FaultDomain *string `json:"fault_domain,omitempty"` // Name of the Azure VM. Field introduced in 17.2.1. Name *string `json:"name,omitempty"` // Resource group name for the VM. Field introduced in 17.2.1. ResourceGroup *string `json:"resource_group,omitempty"` // Subnet ID of the primary nic of the VM. Field introduced in 17.2.1. SubnetID *string `json:"subnet_id,omitempty"` // Update domain within the availability set the VM is a part of. Field introduced in 17.2.1. UpdateDomain *string `json:"update_domain,omitempty"` // Azure VM uuid for the SE VM. Field introduced in 17.2.1. VMUUID *string `json:"vm_uuid,omitempty"` // VNIC id of the primary nic of the VM. Field introduced in 17.2.1. VnicID *string `json:"vnic_id,omitempty"` }
AzureInfo azure info swagger:model AzureInfo
type AzureMarketplace ¶
type AzureMarketplace struct { // Azure Cloud id. Field introduced in 18.2.2. CcID *string `json:"cc_id,omitempty"` // Avi azure marketplace offer name. Field introduced in 18.2.2. Offer *string `json:"offer,omitempty"` // Avi azure marketplace publisher name. Field introduced in 18.2.2. Publisher *string `json:"publisher,omitempty"` // Azure marketplace license term failure status. Field introduced in 18.2.2. Reason *string `json:"reason,omitempty"` // Azure resource group name. Field introduced in 18.2.2. ResourceGroup *string `json:"resource_group,omitempty"` // Avi azure marketplace skus list. Field introduced in 18.2.2. Skus []string `json:"skus,omitempty"` // Azure marketplace license term acceptance status. Field introduced in 18.2.2. Status *string `json:"status,omitempty"` // Azure Subscription id. Field introduced in 18.2.2. SubscriptionID *string `json:"subscription_id,omitempty"` // Azure Vnet id. Field introduced in 18.2.2. VnetID *string `json:"vnet_id,omitempty"` }
AzureMarketplace azure marketplace swagger:model AzureMarketplace
type AzureNetworkInfo ¶
type AzureNetworkInfo struct { // Id of the Azure subnet used as management network for the Service Engines. If set, Service Engines will have a dedicated management NIC, otherwise, they operate in inband mode. Field introduced in 18.2.3. ManagementNetworkID *string `json:"management_network_id,omitempty"` // Id of the Azure subnet where Avi Controller will create the Service Engines. . Field introduced in 17.2.1. SeNetworkID *string `json:"se_network_id,omitempty"` // Virtual network where Virtual IPs will belong. Field introduced in 17.2.1. VirtualNetworkID *string `json:"virtual_network_id,omitempty"` }
AzureNetworkInfo azure network info swagger:model AzureNetworkInfo
type AzureServicePrincipalCredentials ¶
type AzureServicePrincipalCredentials struct { // Application Id created for Avi Controller. Required for application id based authentication only. Field introduced in 17.2.1. ApplicationID *string `json:"application_id,omitempty"` // Authentication token created for the Avi Controller application. Required for application id based authentication only. Field introduced in 17.2.1. AuthenticationToken *string `json:"authentication_token,omitempty"` // Tenant ID for the subscription. Required for application id based authentication only. Field introduced in 17.2.1. TenantID *string `json:"tenant_id,omitempty"` }
AzureServicePrincipalCredentials azure service principal credentials swagger:model AzureServicePrincipalCredentials
type AzureSetup ¶
type AzureSetup struct { // alb_id of AzureSetup. AlbID *string `json:"alb_id,omitempty"` // cc_id of AzureSetup. CcID *string `json:"cc_id,omitempty"` // nic_id of AzureSetup. NicID *string `json:"nic_id,omitempty"` // reason of AzureSetup. Reason *string `json:"reason,omitempty"` // resource_group of AzureSetup. ResourceGroup *string `json:"resource_group,omitempty"` // status of AzureSetup. Status *string `json:"status,omitempty"` // subscription_id of AzureSetup. SubscriptionID *string `json:"subscription_id,omitempty"` // Placeholder for description of property vips of obj type AzureSetup field type str type object Vips []*IPAddr `json:"vips,omitempty"` // vnet_id of AzureSetup. VnetID *string `json:"vnet_id,omitempty"` // Unique object identifiers of vss. VsUuids []string `json:"vs_uuids,omitempty"` }
AzureSetup azure setup swagger:model AzureSetup
type AzureUserPassCredentials ¶
type AzureUserPassCredentials struct { // Password for Azure subscription. Required only if username is provided. Field introduced in 17.2.1. Password *string `json:"password,omitempty"` // Tenant or the active directory associated with the subscription. Required for user name password authentication. Field introduced in 17.2.1. TenantName *string `json:"tenant_name,omitempty"` // Username for Azure subscription. Required only for username password based authentication. Field introduced in 17.2.1. Username *string `json:"username,omitempty"` }
AzureUserPassCredentials azure user pass credentials swagger:model AzureUserPassCredentials
type BMSetup ¶
type BMSetup struct { // cc_id of BMSetup. CcID *string `json:"cc_id,omitempty"` // error_string of BMSetup. ErrorString *string `json:"error_string,omitempty"` }
BMSetup b m setup swagger:model BMSetup
type Backup ¶
type Backup struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // BackupConfiguration Information. It is a reference to an object of type BackupConfiguration. BackupConfigRef *string `json:"backup_config_ref,omitempty"` // The file name of backup. // Required: true FileName *string `json:"file_name"` // URL to download the backup file. LocalFileURL *string `json:"local_file_url,omitempty"` // URL to download the backup file. RemoteFileURL *string `json:"remote_file_url,omitempty"` // Scheduler Information. It is a reference to an object of type Scheduler. SchedulerRef *string `json:"scheduler_ref,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Unix Timestamp of when the backup file is created. Timestamp *string `json:"timestamp,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
Backup backup swagger:model Backup
type BackupAPIResponse ¶
type BackupAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Backup `json:"results,omitempty"` }
BackupAPIResponse backup Api response swagger:model BackupApiResponse
type BackupConfiguration ¶
type BackupConfiguration struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // AWS Access Key ID. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. AwsAccessKey *string `json:"aws_access_key,omitempty"` // AWS bucket. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. AwsBucketID *string `json:"aws_bucket_id,omitempty"` // AWS Secret Access Key. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. AwsSecretAccess *string `json:"aws_secret_access,omitempty"` // Prefix of the exported configuration file. Field introduced in 17.1.1. BackupFilePrefix *string `json:"backup_file_prefix,omitempty"` // Default passphrase for configuration export and periodic backup. BackupPassphrase *string `json:"backup_passphrase,omitempty"` // Rotate the backup files based on this count. Allowed values are 1-20. MaximumBackupsStored *int32 `json:"maximum_backups_stored,omitempty"` // Name of backup configuration. // Required: true Name *string `json:"name"` // Directory at remote destination with write permission for ssh user. RemoteDirectory *string `json:"remote_directory,omitempty"` // Remote Destination. RemoteHostname *string `json:"remote_hostname,omitempty"` // Local Backup. SaveLocal *bool `json:"save_local,omitempty"` // Access Credentials for remote destination. It is a reference to an object of type CloudConnectorUser. SSHUserRef *string `json:"ssh_user_ref,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Remote Backup. UploadToRemoteHost *bool `json:"upload_to_remote_host,omitempty"` // Cloud Backup. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. UploadToS3 *bool `json:"upload_to_s3,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
BackupConfiguration backup configuration swagger:model BackupConfiguration
type BackupConfigurationAPIResponse ¶
type BackupConfigurationAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*BackupConfiguration `json:"results,omitempty"` }
BackupConfigurationAPIResponse backup configuration Api response swagger:model BackupConfigurationApiResponse
type BfdProfile ¶
type BfdProfile struct { // Default required minimum receive interval (in ms) used in BFD. Allowed values are 500-4000000. Field introduced in 20.1.1. Unit is MILLISECONDS. Minrx *int32 `json:"minrx,omitempty"` // Default desired minimum transmit interval (in ms) used in BFD. Allowed values are 500-4000000. Field introduced in 20.1.1. Unit is MILLISECONDS. Mintx *int32 `json:"mintx,omitempty"` // Default detection multiplier used in BFD. Allowed values are 3-255. Field introduced in 20.1.1. Multi *int32 `json:"multi,omitempty"` }
BfdProfile bfd profile swagger:model BfdProfile
type BgpPeer ¶
type BgpPeer struct { // Advertise SNAT IP to this Peer. AdvertiseSnatIP *bool `json:"advertise_snat_ip,omitempty"` // Advertise VIP to this Peer. AdvertiseVip *bool `json:"advertise_vip,omitempty"` // Advertisement interval for this Peer. Allowed values are 1-60. AdvertisementInterval *int32 `json:"advertisement_interval,omitempty"` // Enable Bi-Directional Forward Detection. Only async mode supported. Bfd *bool `json:"bfd,omitempty"` // Connect timer for this Peer. Allowed values are 1-120. ConnectTimer *int32 `json:"connect_timer,omitempty"` // TTL for multihop ebgp Peer. Allowed values are 0-255. Field introduced in 17.1.3. EbgpMultihop *int32 `json:"ebgp_multihop,omitempty"` // Hold time for this Peer. Allowed values are 3-7200. HoldTime *int32 `json:"hold_time,omitempty"` // Keepalive interval for this Peer. Allowed values are 0-3600. KeepaliveInterval *int32 `json:"keepalive_interval,omitempty"` // Label used to enable learning and/or advertisement of routes to this peer. Field introduced in 20.1.1. Label *string `json:"label,omitempty"` // Local AS to use for this ebgp peer. If specified, this will override the local AS configured at the VRF level. Allowed values are 1-4294967295. Field introduced in 17.1.6,17.2.2. LocalAs *int32 `json:"local_as,omitempty"` // Peer Autonomous System Md5 Digest Secret Key. Md5Secret *string `json:"md5_secret,omitempty"` // Network providing reachability for Peer. It is a reference to an object of type Network. NetworkRef *string `json:"network_ref,omitempty"` // IP Address of the BGP Peer. PeerIP *IPAddr `json:"peer_ip,omitempty"` // IPv6 Address of the BGP Peer. Field introduced in 18.1.1. PeerIp6 *IPAddr `json:"peer_ip6,omitempty"` // Peer Autonomous System ID. Allowed values are 1-4294967295. RemoteAs *int32 `json:"remote_as,omitempty"` // Shutdown the BGP peer. Field introduced in 17.2.4. Shutdown *bool `json:"shutdown,omitempty"` // Subnet providing reachability for Peer. Subnet *IPAddrPrefix `json:"subnet,omitempty"` // IPv6 subnet providing reachability for Peer. Field introduced in 18.1.1. Subnet6 *IPAddrPrefix `json:"subnet6,omitempty"` }
BgpPeer bgp peer swagger:model BgpPeer
type BgpProfile ¶
type BgpProfile struct { // Community *string either in aa nn format where aa, nn is within [1,65535] or local-AS|no-advertise|no-export|internet. Field introduced in 17.1.2. Maximum of 16 items allowed. Community []string `json:"community,omitempty"` // Hold time for Peers. Allowed values are 3-7200. HoldTime *int32 `json:"hold_time,omitempty"` // BGP peer type. // Required: true Ibgp *bool `json:"ibgp"` // Communities per IP address range. Field introduced in 17.1.3. Maximum of 1024 items allowed. IPCommunities []*IPCommunity `json:"ip_communities,omitempty"` // Keepalive interval for Peers. Allowed values are 0-3600. KeepaliveInterval *int32 `json:"keepalive_interval,omitempty"` // Local Autonomous System ID. Allowed values are 1-4294967295. // Required: true LocalAs *int32 `json:"local_as"` // LOCAL_PREF to be used for routes advertised. Applicable only over iBGP. Field introduced in 20.1.1. LocalPreference *int32 `json:"local_preference,omitempty"` // Number of times the local AS should be prepended additionally. Allowed values are 1-10. Field introduced in 20.1.1. NumAsPathPrepend *int32 `json:"num_as_path_prepend,omitempty"` // BGP Peers. Maximum of 128 items allowed. Peers []*BgpPeer `json:"peers,omitempty"` // Learning and advertising options for BGP peers. Field introduced in 20.1.1. Maximum of 128 items allowed. RoutingOptions []*BgpRoutingOptions `json:"routing_options,omitempty"` // Send community attribute to all peers. Field introduced in 17.1.2. SendCommunity *bool `json:"send_community,omitempty"` // Shutdown the bgp. Field introduced in 17.2.4. Shutdown *bool `json:"shutdown,omitempty"` }
BgpProfile bgp profile swagger:model BgpProfile
type BgpRoutingOptions ¶
type BgpRoutingOptions struct { // Advertise self as default router to the BGP peer. Field introduced in 20.1.1. AdvertiseDefaultRoute *bool `json:"advertise_default_route,omitempty"` // Advertise the learned routes to the BGP peer. Field introduced in 20.1.1. AdvertiseLearnedRoutes *bool `json:"advertise_learned_routes,omitempty"` // Features are applied to peers matching this label. Field introduced in 20.1.1. // Required: true Label *string `json:"label"` // Learn only default route from the BGP peer. Field introduced in 20.1.1. LearnOnlyDefaultRoute *bool `json:"learn_only_default_route,omitempty"` // Learn routes from the BGP peer. Field introduced in 20.1.1. LearnRoutes *bool `json:"learn_routes,omitempty"` // Maximum number of routes that can be learned from a BGP peer. Allowed values are 50-250. Field introduced in 20.1.1. MaxLearnLimit *int32 `json:"max_learn_limit,omitempty"` }
BgpRoutingOptions bgp routing options swagger:model BgpRoutingOptions
type BotAllowList ¶
type BotAllowList struct { // Allow rules to control which requests undergo BOT detection. Field introduced in 21.1.1. Rules []*BotAllowRule `json:"rules,omitempty"` }
BotAllowList bot allow list swagger:model BotAllowList
type BotAllowRule ¶
type BotAllowRule struct { // The action to take. Enum options - BYPASS, CONTINUE. Field introduced in 21.1.1. // Required: true Action *string `json:"action"` // The conditions to match, combined by logical AND. Field introduced in 21.1.1. Conditions []*MatchTarget `json:"conditions,omitempty"` }
BotAllowRule bot allow rule swagger:model BotAllowRule
type BotClassMatcher ¶
type BotClassMatcher struct { // The list of client classes. Enum options - HUMAN_CLIENT, BOT_CLIENT. Field introduced in 21.1.1. ClientClasses []string `json:"client_classes,omitempty"` // The match operation. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. Op *string `json:"op,omitempty"` }
BotClassMatcher bot class matcher swagger:model BotClassMatcher
type BotClassification ¶
type BotClassification struct { // One of the system-defined Bot classification types. Enum options - HUMAN, GOOD_BOT, BAD_BOT, DANGEROUS_BOT, USER_DEFINED_BOT, UNKNOWN_CLIENT. Field introduced in 21.1.1. // Required: true Type *string `json:"type"` // If 'type' has BotClassificationTypes value 'USER_DEFINED', this is the user-defined value. Field introduced in 21.1.1. UserDefinedType *string `json:"user_defined_type,omitempty"` }
BotClassification bot classification swagger:model BotClassification
type BotConfigConsolidator ¶
type BotConfigConsolidator struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Human-readable description of this consolidator. Field introduced in 21.1.1. Description *string `json:"description,omitempty"` // The name of this consolidator. Field introduced in 21.1.1. // Required: true Name *string `json:"name"` // Script that consolidates results from all components. Field introduced in 21.1.1. Script *string `json:"script,omitempty"` // The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type Tenant. Field introduced in 21.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // A unique identifier to this consolidator. Field introduced in 21.1.1. UUID *string `json:"uuid,omitempty"` }
BotConfigConsolidator bot config consolidator swagger:model BotConfigConsolidator
type BotConfigConsolidatorAPIResponse ¶
type BotConfigConsolidatorAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*BotConfigConsolidator `json:"results,omitempty"` }
BotConfigConsolidatorAPIResponse bot config consolidator Api response swagger:model BotConfigConsolidatorApiResponse
type BotConfigIPLocation ¶
type BotConfigIPLocation struct { // If this is enabled, IP location information is used to determine if a client is a known search engine bot, comes from the cloud, etc. Field introduced in 21.1.1. Enabled *bool `json:"enabled,omitempty"` // The UUID of the Geo-IP databse to use. It is a reference to an object of type GeoDB. Field introduced in 21.1.1. IPLocationDbRef *string `json:"ip_location_db_ref,omitempty"` }
BotConfigIPLocation bot config IP location swagger:model BotConfigIPLocation
type BotConfigIPReputation ¶
type BotConfigIPReputation struct { // Whether IP reputation-based Bot detection is enabled. Field introduced in 21.1.1. Enabled *bool `json:"enabled,omitempty"` // The UUID of the IP reputation DB to use. It is a reference to an object of type IPReputationDB. Field introduced in 21.1.1. IPReputationDbRef *string `json:"ip_reputation_db_ref,omitempty"` // Map every IPReputationType to a bot type (can be unknown). Field introduced in 21.1.1. IPReputationMappings []*IPReputationTypeMapping `json:"ip_reputation_mappings,omitempty"` }
BotConfigIPReputation bot config IP reputation swagger:model BotConfigIPReputation
type BotConfigUserAgent ¶
type BotConfigUserAgent struct { // Whether User Agent-based Bot detection is enabled. Field introduced in 21.1.1. Enabled *bool `json:"enabled,omitempty"` }
BotConfigUserAgent bot config user agent swagger:model BotConfigUserAgent
type BotDetectionMatch ¶
type BotDetectionMatch struct { // Bot classification types. Field introduced in 21.1.1. Classifications []*BotClassification `json:"classifications,omitempty"` // Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. // Required: true MatchOperation *string `json:"match_operation"` }
BotDetectionMatch bot detection match swagger:model BotDetectionMatch
type BotDetectionPolicy ¶
type BotDetectionPolicy struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Allow the user to skip BotManagement for selected requests. Field introduced in 21.1.1. AllowList *BotAllowList `json:"allow_list,omitempty"` // System- and User-defined rules for classification. Field introduced in 21.1.1. BotMappingUuids []string `json:"bot_mapping_uuids,omitempty"` // The installation provides an updated ruleset for consolidating the results of different decider phases. It is a reference to an object of type BotConfigConsolidator. Field introduced in 21.1.1. ConsolidatorRef *string `json:"consolidator_ref,omitempty"` // Human-readable description of this Bot Detection Policy. Field introduced in 21.1.1. Description *string `json:"description,omitempty"` // The IP location configuration used in this policy. Field introduced in 21.1.1. // Required: true IPLocationDetector *BotConfigIPLocation `json:"ip_location_detector"` // The IP reputation configuration used in this policy. Field introduced in 21.1.1. // Required: true IPReputationDetector *BotConfigIPReputation `json:"ip_reputation_detector"` // The name of this Bot Detection Policy. Field introduced in 21.1.1. // Required: true Name *string `json:"name"` // The unique identifier of the tenant to which this policy belongs. It is a reference to an object of type Tenant. Field introduced in 21.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // The User-Agent configuration used in this policy. Field introduced in 21.1.1. // Required: true UserAgentDetector *BotConfigUserAgent `json:"user_agent_detector"` // A unique identifier to this Bot Detection Policy. Field introduced in 21.1.1. UUID *string `json:"uuid,omitempty"` }
BotDetectionPolicy bot detection policy swagger:model BotDetectionPolicy
type BotDetectionPolicyAPIResponse ¶
type BotDetectionPolicyAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*BotDetectionPolicy `json:"results,omitempty"` }
BotDetectionPolicyAPIResponse bot detection policy Api response swagger:model BotDetectionPolicyApiResponse
type BotEvaluationResult ¶
type BotEvaluationResult struct { // The component of the bot module that made this evaluation. Enum options - BOT_DECIDER_CONSOLIDATION, BOT_DECIDER_USER_AGENT, BOT_DECIDER_IP_REPUTATION, BOT_DECIDER_IP_NETWORK_LOCATION. Field introduced in 21.1.1. Component *string `json:"component,omitempty"` // The confidence of this evaluation. Enum options - LOW_CONFIDENCE, MEDIUM_CONFIDENCE, HIGH_CONFIDENCE. Field introduced in 21.1.1. Confidence *string `json:"confidence,omitempty"` // The resultion Bot Identification. Field introduced in 21.1.1. Identification *BotIdentification `json:"identification,omitempty"` // Additional notes for this result. Field introduced in 21.1.1. Notes []string `json:"notes,omitempty"` }
BotEvaluationResult bot evaluation result swagger:model BotEvaluationResult
type BotIdentification ¶
type BotIdentification struct { // The Bot Client Class of this identification. Enum options - HUMAN_CLIENT, BOT_CLIENT. Field introduced in 21.1.1. // Required: true Class *string `json:"class"` // A free-form *string to identify the client. Field introduced in 21.1.1. // Required: true Identifier *string `json:"identifier"` // The Bot Client Type of this identification. Enum options - WEB_BROWSER, IN_APP_BROWSER, SEARCH_ENGINE, IMPERSONATOR, SPAM_SOURCE, WEB_ATTACKS, BOTNET, SCANNER, DENIAL_OF_SERVICE, CLOUD_SOURCE. Field introduced in 21.1.1. Type *string `json:"type,omitempty"` }
BotIdentification bot identification swagger:model BotIdentification
type BotManagementLog ¶
type BotManagementLog struct { // The final classification of the bot management module. Field introduced in 21.1.1. Classification *BotClassification `json:"classification,omitempty"` // The evaluation results of the various bot module components. Field introduced in 21.1.1. Results []*BotEvaluationResult `json:"results,omitempty"` }
BotManagementLog bot management log swagger:model BotManagementLog
type BotMapping ¶
type BotMapping struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Rules for bot classification. Field introduced in 21.1.1. Minimum of 1 items required. MappingRules []*BotMappingRule `json:"mapping_rules,omitempty"` // The name of this mapping. Field introduced in 21.1.1. // Required: true Name *string `json:"name"` // The unique identifier of the tenant to which this mapping belongs. It is a reference to an object of type Tenant. Field introduced in 21.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // A unique identifier of this mapping. Field introduced in 21.1.1. UUID *string `json:"uuid,omitempty"` }
BotMapping bot mapping swagger:model BotMapping
type BotMappingAPIResponse ¶
type BotMappingAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*BotMapping `json:"results,omitempty"` }
BotMappingAPIResponse bot mapping Api response swagger:model BotMappingApiResponse
type BotMappingRule ¶
type BotMappingRule struct { // How to match the BotClientClass. Field introduced in 21.1.1. ClassMatcher *BotClassMatcher `json:"class_matcher,omitempty"` // The assigned classification for this client. Field introduced in 21.1.1. // Required: true Classification *BotClassification `json:"classification"` // The component for which this mapping is used. Enum options - BOT_DECIDER_CONSOLIDATION, BOT_DECIDER_USER_AGENT, BOT_DECIDER_IP_REPUTATION, BOT_DECIDER_IP_NETWORK_LOCATION. Field introduced in 21.1.1. ComponentMatcher *string `json:"component_matcher,omitempty"` // The list of bot identifier names and how they're matched. Field introduced in 21.1.1. IdentifierMatcher *StringMatch `json:"identifier_matcher,omitempty"` // How to match the BotClientType. Field introduced in 21.1.1. TypeMatcher *BotTypeMatcher `json:"type_matcher,omitempty"` }
BotMappingRule bot mapping rule swagger:model BotMappingRule
type BotTypeMatcher ¶
type BotTypeMatcher struct { // The list of client types. Enum options - WEB_BROWSER, IN_APP_BROWSER, SEARCH_ENGINE, IMPERSONATOR, SPAM_SOURCE, WEB_ATTACKS, BOTNET, SCANNER, DENIAL_OF_SERVICE, CLOUD_SOURCE. Field introduced in 21.1.1. ClientTypes []string `json:"client_types,omitempty"` // The match operation. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. Op *string `json:"op,omitempty"` }
BotTypeMatcher bot type matcher swagger:model BotTypeMatcher
type BuildInfo ¶
type BuildInfo struct { // Build number for easy identification. Field introduced in 18.2.6. BuildNo *int32 `json:"build_no,omitempty"` // Date when the package created. Field introduced in 18.2.6. Date *string `json:"date,omitempty"` // Min version of the image. Field introduced in 18.2.6. MinVersion *string `json:"min_version,omitempty"` // Patch version of the image. Field introduced in 18.2.6. PatchVersion *string `json:"patch_version,omitempty"` // Product type. Field introduced in 18.2.6. Product *string `json:"product,omitempty"` // Product Name. Field introduced in 18.2.6. ProductName *string `json:"product_name,omitempty"` // Tag related to the package. Field introduced in 18.2.6. Tag *string `json:"tag,omitempty"` // Major version of the image. Field introduced in 18.2.6. Version *string `json:"version,omitempty"` }
BuildInfo build info swagger:model BuildInfo
type BurstLicenseDetails ¶
type BurstLicenseDetails struct { // Number of cores. Cores *int32 `json:"cores,omitempty"` // end_time of BurstLicenseDetails. EndTime *string `json:"end_time,omitempty"` // se_name of BurstLicenseDetails. SeName *string `json:"se_name,omitempty"` // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` // start_time of BurstLicenseDetails. StartTime *string `json:"start_time,omitempty"` }
BurstLicenseDetails burst license details swagger:model BurstLicenseDetails
type CCAgentProperties ¶
type CCAgentProperties struct { // Maximum polls to check for async jobs to finish. AsyncRetries *int32 `json:"async_retries,omitempty"` // Delay between each async job status poll check. Unit is SEC. AsyncRetriesDelay *int32 `json:"async_retries_delay,omitempty"` // Discovery poll target duration; a scale factor of 1+ is computed with the actual discovery (actual/target) and used to tweak slow and fast poll intervals. Unit is SEC. PollDurationTarget *int32 `json:"poll_duration_target,omitempty"` // Fast poll interval. Unit is SEC. PollFastTarget *int32 `json:"poll_fast_target,omitempty"` // Slow poll interval. Unit is SEC. PollSlowTarget *int32 `json:"poll_slow_target,omitempty"` // Maximum polls to check for vnics to be attached to VM. VnicRetries *int32 `json:"vnic_retries,omitempty"` // Delay between each vnic status poll check. Unit is SEC. VnicRetriesDelay *int32 `json:"vnic_retries_delay,omitempty"` }
CCAgentProperties c c agent properties swagger:model CC_AgentProperties
type CCProperties ¶
type CCProperties struct { // Unit is SEC. RPCPollInterval *int32 `json:"rpc_poll_interval,omitempty"` // Number of rpc_queue_size. RPCQueueSize *int32 `json:"rpc_queue_size,omitempty"` }
CCProperties c c properties swagger:model CC_Properties
type CCScaleSetNotifDetails ¶
type CCScaleSetNotifDetails struct { // Cloud id. Field introduced in 18.2.5. CcID *string `json:"cc_id,omitempty"` // Detailed reason for the scale set notification. Field introduced in 18.2.5. Reason *string `json:"reason,omitempty"` // Names of scale sets for which polling failed. Field introduced in 18.2.5. ScalesetNames []string `json:"scaleset_names,omitempty"` }
CCScaleSetNotifDetails c c scale set notif details swagger:model CCScaleSetNotifDetails
type CCVnicInfo ¶
type CCVnicInfo struct { // mac_address of CC_VnicInfo. MacAddress *string `json:"mac_address,omitempty"` // Unique object identifier of network. // Required: true NetworkUUID *string `json:"network_uuid"` // Unique object identifier of port. PortUUID *string `json:"port_uuid,omitempty"` // Enum options - SYSERR_SUCCESS. SYSERR_FAILURE. SYSERR_OUT_OF_MEMORY. SYSERR_NO_ENT. SYSERR_INVAL. SYSERR_ACCESS. SYSERR_FAULT. SYSERR_IO. SYSERR_TIMEOUT. SYSERR_NOT_SUPPORTED. SYSERR_NOT_READY. SYSERR_UPGRADE_IN_PROGRESS. SYSERR_WARM_START_IN_PROGRESS. SYSERR_TRY_AGAIN. SYSERR_NOT_UPGRADING. SYSERR_PENDING. SYSERR_EVENT_GEN_FAILURE. SYSERR_CONFIG_PARAM_MISSING. SYSERR_RANGE. SYSERR_BAD_REQUEST... Status *string `json:"status,omitempty"` // status_string of CC_VnicInfo. StatusString *string `json:"status_string,omitempty"` // Unique object identifier of subnet. SubnetUUID *string `json:"subnet_uuid,omitempty"` // Unique object identifier of vrf. VrfUUID *string `json:"vrf_uuid,omitempty"` }
CCVnicInfo c c vnic info swagger:model CC_VnicInfo
type CRL ¶
type CRL struct { // Certificate Revocation list from a given issuer in PEM format. This can either be configured directly or via the server_url. . Body *string `json:"body,omitempty"` // Common name of the issuer in the Certificate Revocation list. CommonName *string `json:"common_name,omitempty"` // Distinguished name of the issuer in the Certificate Revocation list. DistinguishedName *string `json:"distinguished_name,omitempty"` // Cached etag to optimize the download of the CRL. Etag *string `json:"etag,omitempty"` // Fingerprint of the CRL. Used to avoid configuring duplicates. Fingerprint *string `json:"fingerprint,omitempty"` // Last time CRL was refreshed by the system. This is an internal field used by the system. LastRefreshed *string `json:"last_refreshed,omitempty"` // The date when this CRL was last issued. LastUpdate *string `json:"last_update,omitempty"` // The date when a newer CRL will be available. Also conveys the date after which the CRL should be considered obsolete. NextUpdate *string `json:"next_update,omitempty"` // URL of a server that issues the Certificate Revocation list. If this is configured, CRL will be periodically downloaded either based on the configured update interval or the next update interval in the CRL. CRL itself is stored in the body. ServerURL *string `json:"server_url,omitempty"` // Certificate Revocation list in plain text for readability. Text *string `json:"text,omitempty"` // Interval in minutes to check for CRL update. If not specified, interval will be 1 day. Allowed values are 30-525600. Unit is MIN. UpdateInterval *int32 `json:"update_interval,omitempty"` }
CRL c r l swagger:model CRL
type CRSDeploymentFailure ¶
type CRSDeploymentFailure struct { // List of all CRS updates that failed to install. Field introduced in 20.1.1. CrsInfo []*CRSDetails `json:"crs_info,omitempty"` // Error message to be conveyed to controller UI. Field introduced in 20.1.1. Message *string `json:"message,omitempty"` }
CRSDeploymentFailure c r s deployment failure swagger:model CRSDeploymentFailure
type CRSDeploymentSuccess ¶
type CRSDeploymentSuccess struct { // List of all installed CRS updates. Field introduced in 20.1.1. CrsInfo []*CRSDetails `json:"crs_info,omitempty"` }
CRSDeploymentSuccess c r s deployment success swagger:model CRSDeploymentSuccess
type CRSDetails ¶
type CRSDetails struct { // Name of the CRS release. Field introduced in 18.2.6. Name *string `json:"name,omitempty"` // CRS release date. Field introduced in 18.2.6. ReleaseDate *string `json:"release_date,omitempty"` // Download link of the CRS release. Field introduced in 18.2.6. URL *string `json:"url,omitempty"` // Version of the CRS release. Field introduced in 18.2.6. Version *string `json:"version,omitempty"` }
CRSDetails c r s details swagger:model CRSDetails
type CRSDetailsAPIResponse ¶
type CRSDetailsAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*CRSDetails `json:"results,omitempty"` }
CRSDetailsAPIResponse c r s details Api response swagger:model CRSDetailsApiResponse
type CRSUpdateDetails ¶
type CRSUpdateDetails struct { // List of all available CRS updates. Field introduced in 20.1.1. CrsInfo []*CRSDetails `json:"crs_info,omitempty"` }
CRSUpdateDetails c r s update details swagger:model CRSUpdateDetails
type CaptureFileSize ¶
type CaptureFileSize struct { // Maximum size in MB. Set 0 for avi default size. Allowed values are 100-512000. Special values are 0 - 'AVI_DEFAULT'. Field introduced in 18.2.8. Unit is MB. AbsoluteSize *int32 `json:"absolute_size,omitempty"` // Limits capture to percentage of free disk space. Set 0 for avi default size. Allowed values are 0-75. Field introduced in 18.2.8. PercentageSize *int32 `json:"percentage_size,omitempty"` }
CaptureFileSize capture file size swagger:model CaptureFileSize
type CaptureFilters ¶
type CaptureFilters struct { // Per packet IP filter. Matches with source and destination address. Curently not applicable for DebugServiceEngine. Field introduced in 18.2.5. CaptureIP *DebugIPAddr `json:"capture_ip,omitempty"` // Capture filter for SE IPC. Not applicable for Debug Virtual Service. Field introduced in 18.2.5. CaptureIpc *CaptureIPC `json:"capture_ipc,omitempty"` // Destination Port range filter. Field introduced in 18.2.5. DstPortEnd *int32 `json:"dst_port_end,omitempty"` // Destination Port range filter. Field introduced in 18.2.5. DstPortStart *int32 `json:"dst_port_start,omitempty"` // Ethernet Proto filter. Enum options - ETH_TYPE_IPV4. Field introduced in 18.2.5. EthProto *string `json:"eth_proto,omitempty"` // IP Proto filter. Support for TCP only for now. Enum options - IP_TYPE_TCP. Field introduced in 18.2.5. IPProto *string `json:"ip_proto,omitempty"` // Source Port filter. Field introduced in 18.2.5. SrcPort *int32 `json:"src_port,omitempty"` // TCP ACK flag filter. Field introduced in 18.2.5. TCPAck *bool `json:"tcp_ack,omitempty"` // TCP FIN flag filter. Field introduced in 18.2.5. TCPFin *bool `json:"tcp_fin,omitempty"` // TCP PUSH flag filter. Field introduced in 18.2.5. TCPPush *bool `json:"tcp_push,omitempty"` // TCP SYN flag filter. Field introduced in 18.2.5. TCPSyn *bool `json:"tcp_syn,omitempty"` }
CaptureFilters capture filters swagger:model CaptureFilters
type CaptureIPC ¶
type CaptureIPC struct { // Flow del probe filter for SE IPC. Field introduced in 18.2.5. FlowDelProbe *bool `json:"flow_del_probe,omitempty"` // Flow mirror add filter for SE IPC. Field introduced in 18.2.5. FlowMirrorAdd *bool `json:"flow_mirror_add,omitempty"` // Filter for all flow mirror SE IPC. Field introduced in 18.2.5. FlowMirrorAll *bool `json:"flow_mirror_all,omitempty"` // Flow mirror del filter for SE IPC. Field introduced in 18.2.5. FlowMirrorDel *bool `json:"flow_mirror_del,omitempty"` // Flow probe filter for SE IPC. Field introduced in 18.2.5. FlowProbe *bool `json:"flow_probe,omitempty"` // Filter for all flow probe SE IPC. Field introduced in 18.2.5. FlowProbeAll *bool `json:"flow_probe_all,omitempty"` // IPC batched filter for SE IPC. Field introduced in 18.2.5. IpcBatched *bool `json:"ipc_batched,omitempty"` // Filter for incoming IPC request. Field introduced in 18.2.5. IpcRxReq *bool `json:"ipc_rx_req,omitempty"` // Filter for incoming IPC response. Field introduced in 18.2.5. IpcRxRes *bool `json:"ipc_rx_res,omitempty"` // Filter for outgoing IPC request. Field introduced in 18.2.5. IpcTxReq *bool `json:"ipc_tx_req,omitempty"` // Filter for outgoing IPC response. Field introduced in 18.2.5. IpcTxRes *bool `json:"ipc_tx_res,omitempty"` // Vs heart beat filter for SE IPC. Field introduced in 18.2.5. VsHb *bool `json:"vs_hb,omitempty"` }
CaptureIPC capture IP c swagger:model CaptureIPC
type CdpLldpInfo ¶
type CdpLldpInfo struct { // chassis of CdpLldpInfo. Chassis *string `json:"chassis,omitempty"` // device of CdpLldpInfo. Device *string `json:"device,omitempty"` // mgmtaddr of CdpLldpInfo. Mgmtaddr *string `json:"mgmtaddr,omitempty"` // port of CdpLldpInfo. Port *string `json:"port,omitempty"` // Enum options - CDP, LLDP, NOT_APPLICABLE. SwitchInfoType *string `json:"switch_info_type,omitempty"` // system_name of CdpLldpInfo. SystemName *string `json:"system_name,omitempty"` }
CdpLldpInfo cdp lldp info swagger:model CdpLldpInfo
type CertificateAuthority ¶
type CertificateAuthority struct { // It is a reference to an object of type SSLKeyAndCertificate. CaRef *string `json:"ca_ref,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` }
CertificateAuthority certificate authority swagger:model CertificateAuthority
type CertificateManagementProfile ¶
type CertificateManagementProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of the PKI Profile. // Required: true Name *string `json:"name"` // Alert script config object for certificate management profile. It is a reference to an object of type AlertScriptConfig. Field introduced in 20.1.3. // Required: true RunScriptRef *string `json:"run_script_ref"` // Placeholder for description of property script_params of obj type CertificateManagementProfile field type str type object ScriptParams []*CustomParams `json:"script_params,omitempty"` // Field deprecated in 20.1.3. ScriptPath *string `json:"script_path,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
CertificateManagementProfile certificate management profile swagger:model CertificateManagementProfile
type CertificateManagementProfileAPIResponse ¶
type CertificateManagementProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*CertificateManagementProfile `json:"results,omitempty"` }
CertificateManagementProfileAPIResponse certificate management profile Api response swagger:model CertificateManagementProfileApiResponse
type CfgState ¶
type CfgState struct { // cfg-version synced to follower. . CfgVersion *int32 `json:"cfg_version,omitempty"` // cfg-version in flight to follower. . CfgVersionInFlight *int32 `json:"cfg_version_in_flight,omitempty"` // Placeholder for description of property last_changed_time of obj type CfgState field type str type object LastChangedTime *TimeStamp `json:"last_changed_time,omitempty"` // reason of CfgState. Reason *string `json:"reason,omitempty"` // site_uuid to which the object was synced. SiteUUID *string `json:"site_uuid,omitempty"` // Status of the object. . Enum options - SYSERR_SUCCESS, SYSERR_FAILURE, SYSERR_OUT_OF_MEMORY, SYSERR_NO_ENT, SYSERR_INVAL, SYSERR_ACCESS, SYSERR_FAULT, SYSERR_IO, SYSERR_TIMEOUT, SYSERR_NOT_SUPPORTED, SYSERR_NOT_READY, SYSERR_UPGRADE_IN_PROGRESS, SYSERR_WARM_START_IN_PROGRESS, SYSERR_TRY_AGAIN, SYSERR_NOT_UPGRADING, SYSERR_PENDING, SYSERR_EVENT_GEN_FAILURE, SYSERR_CONFIG_PARAM_MISSING, SYSERR_RANGE, SYSERR_BAD_REQUEST... Status *string `json:"status,omitempty"` // object-uuid that is being synced to follower. . UUID *string `json:"uuid,omitempty"` }
CfgState cfg state swagger:model CfgState
type ChildProcessInfo ¶
type ChildProcessInfo struct { // Amount of memory (in MB) used by the sub process. Memory *int32 `json:"memory,omitempty"` // Process Id of the sub process. Pid *int32 `json:"pid,omitempty"` }
ChildProcessInfo child process info swagger:model ChildProcessInfo
type Cif ¶
type Cif struct { // adapter of Cif. Adapter *string `json:"adapter,omitempty"` // cif of Cif. Cif *string `json:"cif,omitempty"` // mac_address of Cif. MacAddress *string `json:"mac_address,omitempty"` // resources of Cif. Resources []string `json:"resources,omitempty"` // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` }
Cif cif swagger:model Cif
type ClientInsightsSampling ¶
type ClientInsightsSampling struct { // Client IP addresses to check when inserting RUM script. ClientIP *IPAddrMatch `json:"client_ip,omitempty"` // URL patterns to check when inserting RUM script. SampleUris *StringMatch `json:"sample_uris,omitempty"` // URL patterns to avoid when inserting RUM script. SkipUris *StringMatch `json:"skip_uris,omitempty"` }
ClientInsightsSampling client insights sampling swagger:model ClientInsightsSampling
type ClientLogConfiguration ¶
type ClientLogConfiguration struct { // Enable significant log collection. By default, this flag is enabled, which means that Avi SEs collect significant logs and forward them to Controller for further processing. For example, these logs correspond to error conditions such as when the response code for a request is 500. Users can deactivate this flag to turn off default significant log collection. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. EnableSignificantLogCollection *bool `json:"enable_significant_log_collection,omitempty"` // Filtered logs are logs that match any client log filters or rules with logging enabled. Such logs are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Field introduced in 17.1.1. FilteredLogProcessing *string `json:"filtered_log_processing,omitempty"` // Logs that are neither significant nor filtered, are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Field introduced in 17.1.1. NonSignificantLogProcessing *string `json:"non_significant_log_processing,omitempty"` // Significant logs are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Field introduced in 17.1.1. SignificantLogProcessing *string `json:"significant_log_processing,omitempty"` }
ClientLogConfiguration client log configuration swagger:model ClientLogConfiguration
type ClientLogFilter ¶
type ClientLogFilter struct { // Placeholder for description of property all_headers of obj type ClientLogFilter field type str type boolean AllHeaders *bool `json:"all_headers,omitempty"` // Placeholder for description of property client_ip of obj type ClientLogFilter field type str type object ClientIP *IPAddrMatch `json:"client_ip,omitempty"` // Special values are 0 - 'infinite'. Unit is MIN. Duration *int32 `json:"duration,omitempty"` // Placeholder for description of property enabled of obj type ClientLogFilter field type str type boolean // Required: true Enabled *bool `json:"enabled"` // Number of index. // Required: true Index *int32 `json:"index"` // Name of the object. // Required: true Name *string `json:"name"` // Placeholder for description of property uri of obj type ClientLogFilter field type str type object URI *StringMatch `json:"uri,omitempty"` }
ClientLogFilter client log filter swagger:model ClientLogFilter
type ClientLogStreamingConfig ¶
type ClientLogStreamingConfig struct { // IP address or hostnames (FQDNs) of destination servers. If an FQDN is provided, this should be resolvable on Avi Service Engines. Multiple servers are supported by furnishing a comma-separated list of IP addresses or host names, for example, 11.11.11.11,23.12.12.4. Optionally, a separate port can be specified for each external server in the list, for example, 11.11.11.11 234,12.12.12.12 343. Field introduced in 17.1.1. // Required: true ExternalServer *string `json:"external_server"` // The service port to use for the external servers. If multiple external servers have been specified, the single port number specified here will apply to all those servers for which an explicit port number has not been specified in the external server list. Field introduced in 17.1.1. ExternalServerPort *int32 `json:"external_server_port,omitempty"` // Configuration to specify the format of streamed logs. By default, each log is encoded in JSON format. Field introduced in 18.2.5. FormatConfig *ClientLogStreamingFormat `json:"format_config,omitempty"` // Type of logs to stream to the external server. Default is LOGS_ALL, i.e., send all logs. Enum options - LOGS_SIGNIFICANT_ONLY, LOGS_UDF_ONLY, LOGS_UDF_SIGNIFICANT, LOGS_ALL. Field introduced in 17.1.1. LogTypesToSend *string `json:"log_types_to_send,omitempty"` // Maximum number of logs per second streamed to the remote server. By default, 100 logs per second are streamed. Set this to zero(0) to not enforce any limit. Field introduced in 17.1.1. MaxLogsPerSecond *int32 `json:"max_logs_per_second,omitempty"` // Protocol to use for streaming logs. Enum options - LOG_STREAMING_PROTOCOL_UDP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_UDP, LOG_STREAMING_PROTOCOL_TCP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TCP, LOG_STREAMING_PROTOCOL_RAW_OVER_UDP, LOG_STREAMING_PROTOCOL_TLS, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TLS. Field introduced in 18.1.1. Protocol *string `json:"protocol,omitempty"` // Syslog configuration if a Syslog-based protocol is specified for streaming. Field introduced in 18.1.1. SyslogConfig *StreamingSyslogConfig `json:"syslog_config,omitempty"` }
ClientLogStreamingConfig client log streaming config swagger:model ClientLogStreamingConfig
type ClientLogStreamingFormat ¶
type ClientLogStreamingFormat struct { // Format for the streamed logs. Enum options - LOG_STREAMING_FORMAT_JSON_FULL, LOG_STREAMING_FORMAT_JSON_SELECTED. Field introduced in 18.2.5. // Required: true Format *string `json:"format"` // List of log fields to be streamed, when selective fields (LOG_STREAMING_FORMAT_JSON_SELECTED) option is chosen. Only top-level fields in application or connection logs are supported. Field introduced in 18.2.5. IncludedFields []string `json:"included_fields,omitempty"` }
ClientLogStreamingFormat client log streaming format swagger:model ClientLogStreamingFormat
type CloneServer ¶
type CloneServer struct { // IP Address of the Clone Server. Field introduced in 17.1.1. IPAddress *IPAddr `json:"ip_address,omitempty"` // MAC Address of the Clone Server. Field introduced in 17.1.1. Mac *string `json:"mac,omitempty"` // Network to clone the traffic to. It is a reference to an object of type Network. Field introduced in 17.1.1. NetworkRef *string `json:"network_ref,omitempty"` // Subnet of the network to clone the traffic to. Field introduced in 17.1.1. Subnet *IPAddrPrefix `json:"subnet,omitempty"` }
CloneServer clone server swagger:model CloneServer
type Cloud ¶
type Cloud struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Placeholder for description of property apic_configuration of obj type Cloud field type str type object ApicConfiguration *APICConfiguration `json:"apic_configuration,omitempty"` // Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ApicMode *bool `json:"apic_mode,omitempty"` // CloudConnector polling interval in seconds for external autoscale groups, minimum 60 seconds. Allowed values are 60-3600. Field introduced in 18.2.2. Unit is SECONDS. Allowed in Basic(Allowed values- 60) edition, Essentials(Allowed values- 60) edition, Enterprise edition. AutoscalePollingInterval *int32 `json:"autoscale_polling_interval,omitempty"` // Placeholder for description of property aws_configuration of obj type Cloud field type str type object AwsConfiguration *AwsConfiguration `json:"aws_configuration,omitempty"` // Field introduced in 17.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. AzureConfiguration *AzureConfiguration `json:"azure_configuration,omitempty"` // Placeholder for description of property cloudstack_configuration of obj type Cloud field type str type object CloudstackConfiguration *CloudStackConfiguration `json:"cloudstack_configuration,omitempty"` // Custom tags for all Avi created resources in the cloud infrastructure. Field introduced in 17.1.5. CustomTags []*CustomTag `json:"custom_tags,omitempty"` // Select the IP address management scheme. DhcpEnabled *bool `json:"dhcp_enabled,omitempty"` // DNS Profile for the cloud. It is a reference to an object of type IpamDnsProviderProfile. DNSProviderRef *string `json:"dns_provider_ref,omitempty"` // By default, pool member FQDNs are resolved on the Controller. When this is set, pool member FQDNs are instead resolved on Service Engines in this cloud. This is useful in scenarios where pool member FQDNs can only be resolved from Service Engines and not from the Controller. Field introduced in 18.2.6. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. DNSResolutionOnSe *bool `json:"dns_resolution_on_se,omitempty"` // Placeholder for description of property docker_configuration of obj type Cloud field type str type object DockerConfiguration *DockerConfiguration `json:"docker_configuration,omitempty"` // DNS Profile for East-West services. It is a reference to an object of type IpamDnsProviderProfile. EastWestDNSProviderRef *string `json:"east_west_dns_provider_ref,omitempty"` // Ipam Profile for East-West services. Warning - Please use virtual subnets in this IPAM profile that do not conflict with the underlay networks or any overlay networks in the cluster. For example in AWS and GCP, 169.254.0.0/16 is used for storing instance metadata. Hence, it should not be used in this profile. It is a reference to an object of type IpamDnsProviderProfile. EastWestIPAMProviderRef *string `json:"east_west_ipam_provider_ref,omitempty"` // Enable VIP on all data interfaces for the Cloud. Field introduced in 18.2.9, 20.1.1. EnableVipOnAllInterfaces *bool `json:"enable_vip_on_all_interfaces,omitempty"` // Use static routes for VIP side network resolution during VirtualService placement. EnableVipStaticRoutes *bool `json:"enable_vip_static_routes,omitempty"` // Google Cloud Platform Configuration. Field introduced in 18.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. GcpConfiguration *GCPConfiguration `json:"gcp_configuration,omitempty"` // Enable IPv6 auto configuration. Field introduced in 18.1.1. Ip6AutocfgEnabled *bool `json:"ip6_autocfg_enabled,omitempty"` // Ipam Profile for the cloud. It is a reference to an object of type IpamDnsProviderProfile. IPAMProviderRef *string `json:"ipam_provider_ref,omitempty"` // Specifies the default license tier which would be used by new SE Groups. This field by default inherits the value from system configuration. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS. Field introduced in 17.2.5. LicenseTier *string `json:"license_tier,omitempty"` // If no license type is specified then default license enforcement for the cloud type is chosen. The default mappings are Container Cloud is Max Ses, OpenStack and VMware is cores and linux it is Sockets. Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH. LicenseType *string `json:"license_type,omitempty"` // Placeholder for description of property linuxserver_configuration of obj type Cloud field type str type object LinuxserverConfiguration *LinuxServerConfiguration `json:"linuxserver_configuration,omitempty"` // Field deprecated in 18.2.2. MesosConfiguration *MesosConfiguration `json:"mesos_configuration,omitempty"` // MTU setting for the cloud. Unit is BYTES. Mtu *int32 `json:"mtu,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Configuration parameters for NSX Manager. Field introduced in 17.1.1. NsxConfiguration *NsxConfiguration `json:"nsx_configuration,omitempty"` // NSX-T Cloud Platform Configuration. Field introduced in 20.1.1. Allowed in Essentials edition, Enterprise edition. NsxtConfiguration *NsxtConfiguration `json:"nsxt_configuration,omitempty"` // Default prefix for all automatically created objects in this cloud. This prefix can be overridden by the SE-Group template. ObjNamePrefix *string `json:"obj_name_prefix,omitempty"` // Placeholder for description of property openstack_configuration of obj type Cloud field type str type object OpenstackConfiguration *OpenStackConfiguration `json:"openstack_configuration,omitempty"` // Field deprecated in 20.1.1. Oshiftk8sConfiguration *OShiftK8SConfiguration `json:"oshiftk8s_configuration,omitempty"` // Prefer static routes over interface routes during VirtualService placement. PreferStaticRoutes *bool `json:"prefer_static_routes,omitempty"` // Placeholder for description of property proxy_configuration of obj type Cloud field type str type object ProxyConfiguration *ProxyConfiguration `json:"proxy_configuration,omitempty"` // Placeholder for description of property rancher_configuration of obj type Cloud field type str type object RancherConfiguration *RancherConfiguration `json:"rancher_configuration,omitempty"` // The Service Engine Group to use as template. It is a reference to an object of type ServiceEngineGroup. Field introduced in 18.2.5. SeGroupTemplateRef *string `json:"se_group_template_ref,omitempty"` // DNS records for VIPs are added/deleted based on the operational state of the VIPs. Field introduced in 17.1.12. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. StateBasedDNSRegistration *bool `json:"state_based_dns_registration,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Placeholder for description of property vca_configuration of obj type Cloud field type str type object VcaConfiguration *VCloudAirConfiguration `json:"vca_configuration,omitempty"` // Placeholder for description of property vcenter_configuration of obj type Cloud field type str type object VcenterConfiguration *VCenterConfiguration `json:"vcenter_configuration,omitempty"` // Cloud type. Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Allowed in Basic(Allowed values- CLOUD_NONE,CLOUD_NSXT) edition, Essentials(Allowed values- CLOUD_NONE,CLOUD_VCENTER) edition, Enterprise edition. // Required: true Vtype *string `json:"vtype"` }
Cloud cloud swagger:model Cloud
type CloudAPIResponse ¶
type CloudAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Cloud `json:"results,omitempty"` }
CloudAPIResponse cloud Api response swagger:model CloudApiResponse
type CloudASGNotifDetails ¶
type CloudASGNotifDetails struct { // Autoscale Group name. Field introduced in 20.1.1. AsgName *string `json:"asg_name,omitempty"` // Cloud UUID. Field introduced in 20.1.1. CcID *string `json:"cc_id,omitempty"` // Failure reason if Autoscale Group creation or deletion fails. Field introduced in 20.1.1. ErrorString *string `json:"error_string,omitempty"` // Pool UUID. It is a reference to an object of type Pool. Field introduced in 20.1.1. PoolRef *string `json:"pool_ref,omitempty"` }
CloudASGNotifDetails cloud a s g notif details swagger:model CloudASGNotifDetails
type CloudAutoscalingConfigFailureDetails ¶
type CloudAutoscalingConfigFailureDetails struct { // Cloud UUID. Field introduced in 20.1.1. CcID *string `json:"cc_id,omitempty"` // Failure reason if Autoscaling configuration fails. Field introduced in 20.1.1. ErrorString *string `json:"error_string,omitempty"` }
CloudAutoscalingConfigFailureDetails cloud autoscaling config failure details swagger:model CloudAutoscalingConfigFailureDetails
type CloudClusterVip ¶
type CloudClusterVip struct { // cc_id of CloudClusterVip. CcID *string `json:"cc_id,omitempty"` // error_string of CloudClusterVip. ErrorString *string `json:"error_string,omitempty"` // Placeholder for description of property ip of obj type CloudClusterVip field type str type object // Required: true IP *IPAddr `json:"ip"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudClusterVip cloud cluster vip swagger:model CloudClusterVip
type CloudConnectorDebugFilter ¶
type CloudConnectorDebugFilter struct { // filter debugs for an app. AppID *string `json:"app_id,omitempty"` // Disable SE reboot via cloud connector on HB miss. DisableSeReboot *bool `json:"disable_se_reboot,omitempty"` // filter debugs for a SE. SeID *string `json:"se_id,omitempty"` }
CloudConnectorDebugFilter cloud connector debug filter swagger:model CloudConnectorDebugFilter
type CloudConnectorUser ¶
type CloudConnectorUser struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Field introduced in 17.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. AzureServiceprincipal *AzureServicePrincipalCredentials `json:"azure_serviceprincipal,omitempty"` // Field introduced in 17.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. AzureUserpass *AzureUserPassCredentials `json:"azure_userpass,omitempty"` // Credentials for Google Cloud Platform. Field introduced in 18.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. GcpCredentials *GCPCredentials `json:"gcp_credentials,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Credentials to talk to NSX-T manager. Field introduced in 20.1.1. Allowed in Essentials edition, Enterprise edition. NsxtCredentials *NsxtCredentials `json:"nsxt_credentials,omitempty"` // Credentials for Oracle Cloud Infrastructure. Field introduced in 18.2.1,18.1.3. Allowed in Basic edition, Essentials edition, Enterprise edition. OciCredentials *OCICredentials `json:"oci_credentials,omitempty"` // password of CloudConnectorUser. Password *string `json:"password,omitempty"` // private_key of CloudConnectorUser. PrivateKey *string `json:"private_key,omitempty"` // public_key of CloudConnectorUser. PublicKey *string `json:"public_key,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Credentials for Tencent Cloud. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. TencentCredentials *TencentCredentials `json:"tencent_credentials,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Credentials to talk to VCenter. Field introduced in 20.1.1. VcenterCredentials *VCenterCredentials `json:"vcenter_credentials,omitempty"` }
CloudConnectorUser cloud connector user swagger:model CloudConnectorUser
type CloudConnectorUserAPIResponse ¶
type CloudConnectorUserAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*CloudConnectorUser `json:"results,omitempty"` }
CloudConnectorUserAPIResponse cloud connector user Api response swagger:model CloudConnectorUserApiResponse
type CloudConnectorUserTestParams ¶
type CloudConnectorUserTestParams struct { // host of CloudConnectorUserTestParams. Host *string `json:"host,omitempty"` }
CloudConnectorUserTestParams cloud connector user test params swagger:model CloudConnectorUserTestParams
type CloudDNSUpdate ¶
type CloudDNSUpdate struct { // cc_id of CloudDnsUpdate. CcID *string `json:"cc_id,omitempty"` // dns_fqdn of CloudDnsUpdate. DNSFqdn *string `json:"dns_fqdn,omitempty"` // error_string of CloudDnsUpdate. ErrorString *string `json:"error_string,omitempty"` // Placeholder for description of property fip of obj type CloudDnsUpdate field type str type object Fip *IPAddr `json:"fip,omitempty"` // Placeholder for description of property vip of obj type CloudDnsUpdate field type str type object Vip *IPAddr `json:"vip,omitempty"` // Unique object identifier of vs. VsUUID *string `json:"vs_uuid,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudDNSUpdate cloud Dns update swagger:model CloudDnsUpdate
type CloudFlavor ¶
type CloudFlavor struct { // cost of CloudFlavor. Cost *string `json:"cost,omitempty"` // Number of disk_gb. DiskGb *int32 `json:"disk_gb,omitempty"` // Placeholder for description of property enhanced_nw of obj type CloudFlavor field type str type boolean EnhancedNw *bool `json:"enhanced_nw,omitempty"` // id of CloudFlavor. // Required: true ID *string `json:"id"` // If a vm flavor is recommended for requested se_usage_type.Set to True if the chosen VM flavor is recommended for requested se_usage_type.Else set to False. Field introduced in 18.1.4, 18.2.1. IsRecommended *bool `json:"is_recommended,omitempty"` // Maximum number of IPv6 addresses that can be configured per NIC. Field introduced in 18.1.1. MaxIP6SPerNic *int32 `json:"max_ip6s_per_nic,omitempty"` // Number of max_ips_per_nic. MaxIpsPerNic *int32 `json:"max_ips_per_nic,omitempty"` // Number of max_nics. MaxNics *int32 `json:"max_nics,omitempty"` // Placeholder for description of property meta of obj type CloudFlavor field type str type object Meta []*CloudMeta `json:"meta,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Placeholder for description of property public of obj type CloudFlavor field type str type boolean Public *bool `json:"public,omitempty"` // Number of ram_mb. RAMMb *int32 `json:"ram_mb,omitempty"` // Number of vcpus. Vcpus *int32 `json:"vcpus,omitempty"` }
CloudFlavor cloud flavor swagger:model CloudFlavor
type CloudGeneric ¶
type CloudGeneric struct { // cc_id of CloudGeneric. CcID *string `json:"cc_id,omitempty"` // error_string of CloudGeneric. ErrorString *string `json:"error_string,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudGeneric cloud generic swagger:model CloudGeneric
type CloudHealth ¶
type CloudHealth struct { // cc_id of CloudHealth. CcID *string `json:"cc_id,omitempty"` // error_string of CloudHealth. ErrorString *string `json:"error_string,omitempty"` // first_fail of CloudHealth. FirstFail *string `json:"first_fail,omitempty"` // last_fail of CloudHealth. LastFail *string `json:"last_fail,omitempty"` // last_ok of CloudHealth. LastOk *string `json:"last_ok,omitempty"` // Number of num_fails. NumFails *int32 `json:"num_fails,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudHealth cloud health swagger:model CloudHealth
type CloudIPChange ¶
type CloudIPChange struct { // cc_id of CloudIpChange. CcID *string `json:"cc_id,omitempty"` // error_string of CloudIpChange. ErrorString *string `json:"error_string,omitempty"` // Placeholder for description of property ip of obj type CloudIpChange field type str type object // Required: true IP *IPAddr `json:"ip"` // Field introduced in 18.1.1. Ip6 *IPAddr `json:"ip6,omitempty"` // Field introduced in 18.1.1. Ip6Mask *int32 `json:"ip6_mask,omitempty"` // Field introduced in 17.1.1. IPMask *int32 `json:"ip_mask,omitempty"` // mac_addr of CloudIpChange. MacAddr *string `json:"mac_addr,omitempty"` // Unique object identifier of port. PortUUID *string `json:"port_uuid,omitempty"` // Unique object identifier of se_vm. SeVMUUID *string `json:"se_vm_uuid,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudIPChange cloud Ip change swagger:model CloudIpChange
type CloudInfo ¶
type CloudInfo struct { // CloudConnectorAgent properties specific to this cloud type. CcaProps *CCAgentProperties `json:"cca_props,omitempty"` // Controller properties specific to this cloud type. ControllerProps *ControllerProperties `json:"controller_props,omitempty"` // Flavor properties specific to this cloud type. FlavorProps []*CloudFlavor `json:"flavor_props,omitempty"` // flavor_regex_filter of CloudInfo. FlavorRegexFilter *string `json:"flavor_regex_filter,omitempty"` // Supported hypervisors. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Htypes []string `json:"htypes,omitempty"` // Cloud type. Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. // Required: true Vtype *string `json:"vtype"` }
CloudInfo cloud info swagger:model CloudInfo
type CloudMeta ¶
type CloudMeta struct { // key of CloudMeta. // Required: true Key *string `json:"key"` // value of CloudMeta. // Required: true Value *string `json:"value"` }
CloudMeta cloud meta swagger:model CloudMeta
type CloudProperties ¶
type CloudProperties struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // CloudConnector properties. CcProps *CCProperties `json:"cc_props,omitempty"` // Cloud types supported by CloudConnector. Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. CcVtypes []string `json:"cc_vtypes,omitempty"` // Hypervisor properties. HypProps []*HypervisorProperties `json:"hyp_props,omitempty"` // Properties specific to a cloud type. Info []*CloudInfo `json:"info,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
CloudProperties cloud properties swagger:model CloudProperties
type CloudPropertiesAPIResponse ¶
type CloudPropertiesAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*CloudProperties `json:"results,omitempty"` }
CloudPropertiesAPIResponse cloud properties Api response swagger:model CloudPropertiesApiResponse
type CloudRouteNotifDetails ¶
type CloudRouteNotifDetails struct { // Cloud id. Field introduced in 20.1.3. CcID *string `json:"cc_id,omitempty"` // Detailed reason for the route update notification. Field introduced in 20.1.3. Reason *string `json:"reason,omitempty"` // Name of route table for which update was performed. Field introduced in 20.1.3. RouteTable *string `json:"route_table,omitempty"` // Names of routes for which update was performed. Field introduced in 20.1.3. Routes []string `json:"routes,omitempty"` }
CloudRouteNotifDetails cloud route notif details swagger:model CloudRouteNotifDetails
type CloudRuntime ¶
type CloudRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Placeholder for description of property network_sync_complete of obj type CloudRuntime field type str type boolean NetworkSyncComplete *bool `json:"network_sync_complete,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
CloudRuntime cloud runtime swagger:model CloudRuntime
type CloudRuntimeAPIResponse ¶
type CloudRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*CloudRuntime `json:"results,omitempty"` }
CloudRuntimeAPIResponse cloud runtime Api response swagger:model CloudRuntimeApiResponse
type CloudSeVMChange ¶
type CloudSeVMChange struct { // cc_id of CloudSeVmChange. CcID *string `json:"cc_id,omitempty"` // error_string of CloudSeVmChange. ErrorString *string `json:"error_string,omitempty"` // Unique object identifier of se_vm. SeVMUUID *string `json:"se_vm_uuid,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudSeVMChange cloud se Vm change swagger:model CloudSeVmChange
type CloudStackConfiguration ¶
type CloudStackConfiguration struct { // CloudStack API Key. // Required: true AccessKeyID *string `json:"access_key_id"` // CloudStack API URL. // Required: true APIURL *string `json:"api_url"` // If controller's management IP is in a private network, a publicly accessible IP to reach the controller. CntrPublicIP *string `json:"cntr_public_ip,omitempty"` // Default hypervisor type. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Hypervisor *string `json:"hypervisor,omitempty"` // Avi Management network name. // Required: true MgmtNetworkName *string `json:"mgmt_network_name"` // Avi Management network name. MgmtNetworkUUID *string `json:"mgmt_network_uuid,omitempty"` // CloudStack Secret Key. // Required: true SecretAccessKey *string `json:"secret_access_key"` }
CloudStackConfiguration cloud stack configuration swagger:model CloudStackConfiguration
type CloudStackSetup ¶
type CloudStackSetup struct { // access_key_id of CloudStackSetup. AccessKeyID *string `json:"access_key_id,omitempty"` // api_url of CloudStackSetup. APIURL *string `json:"api_url,omitempty"` // cc_id of CloudStackSetup. CcID *string `json:"cc_id,omitempty"` // error_string of CloudStackSetup. ErrorString *string `json:"error_string,omitempty"` // Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Privilege *string `json:"privilege,omitempty"` }
CloudStackSetup cloud stack setup swagger:model CloudStackSetup
type CloudSyncServices ¶
type CloudSyncServices struct { // cc_id of CloudSyncServices. CcID *string `json:"cc_id,omitempty"` // error_string of CloudSyncServices. ErrorString *string `json:"error_string,omitempty"` // Unique object identifier of se_vm. SeVMUUID *string `json:"se_vm_uuid,omitempty"` // List of vips. Field introduced in 18.2.2. Vips []*IPAddr `json:"vips,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudSyncServices cloud sync services swagger:model CloudSyncServices
type CloudTenantCleanup ¶
type CloudTenantCleanup struct { // id of CloudTenantCleanup. ID *string `json:"id,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Number of num_ports. NumPorts *int32 `json:"num_ports,omitempty"` // Number of num_se. NumSe *int32 `json:"num_se,omitempty"` // Number of num_secgrp. NumSecgrp *int32 `json:"num_secgrp,omitempty"` // Number of num_svrgrp. NumSvrgrp *int32 `json:"num_svrgrp,omitempty"` }
CloudTenantCleanup cloud tenant cleanup swagger:model CloudTenantCleanup
type CloudTenantsDeleted ¶
type CloudTenantsDeleted struct { // cc_id of CloudTenantsDeleted. CcID *string `json:"cc_id,omitempty"` // Placeholder for description of property tenants of obj type CloudTenantsDeleted field type str type object Tenants []*CloudTenantCleanup `json:"tenants,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudTenantsDeleted cloud tenants deleted swagger:model CloudTenantsDeleted
type CloudVipParkingIntf ¶
type CloudVipParkingIntf struct { // cc_id of CloudVipParkingIntf. CcID *string `json:"cc_id,omitempty"` // error_string of CloudVipParkingIntf. ErrorString *string `json:"error_string,omitempty"` // intf_id of CloudVipParkingIntf. IntfID *string `json:"intf_id,omitempty"` // subnet_id of CloudVipParkingIntf. // Required: true SubnetID *string `json:"subnet_id"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudVipParkingIntf cloud vip parking intf swagger:model CloudVipParkingIntf
type CloudVipUpdate ¶
type CloudVipUpdate struct { // cc_id of CloudVipUpdate. CcID *string `json:"cc_id,omitempty"` // error_string of CloudVipUpdate. ErrorString *string `json:"error_string,omitempty"` // Unique object identifier of vs. VsUUID *string `json:"vs_uuid,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudVipUpdate cloud vip update swagger:model CloudVipUpdate
type CloudVnicChange ¶
type CloudVnicChange struct { // cc_id of CloudVnicChange. CcID *string `json:"cc_id,omitempty"` // error_string of CloudVnicChange. ErrorString *string `json:"error_string,omitempty"` // mac_addrs of CloudVnicChange. MacAddrs []string `json:"mac_addrs,omitempty"` // Unique object identifier of se_vm. // Required: true SeVMUUID *string `json:"se_vm_uuid"` // Placeholder for description of property vnics of obj type CloudVnicChange field type str type object Vnics []*CCVnicInfo `json:"vnics,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Vtype *string `json:"vtype,omitempty"` }
CloudVnicChange cloud vnic change swagger:model CloudVnicChange
type ClusterCloudDetails ¶
type ClusterCloudDetails struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Azure info to configure cluster_vip on the controller. Field introduced in 17.2.5. AzureInfo *AzureClusterInfo `json:"azure_info,omitempty"` // Field introduced in 17.2.5. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 17.2.5. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 17.2.5. UUID *string `json:"uuid,omitempty"` }
ClusterCloudDetails cluster cloud details swagger:model ClusterCloudDetails
type ClusterCloudDetailsAPIResponse ¶
type ClusterCloudDetailsAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ClusterCloudDetails `json:"results,omitempty"` }
ClusterCloudDetailsAPIResponse cluster cloud details Api response swagger:model ClusterCloudDetailsApiResponse
type ClusterConfigFailedEvent ¶
type ClusterConfigFailedEvent struct { // Failure reason. Reason *string `json:"reason,omitempty"` }
ClusterConfigFailedEvent cluster config failed event swagger:model ClusterConfigFailedEvent
type ClusterLeaderFailoverEvent ¶
type ClusterLeaderFailoverEvent struct { // Details of the new controller cluster leader node. LeaderNode *ClusterNode `json:"leader_node,omitempty"` // Details of the previous controller cluster leader. PreviousLeaderNode *ClusterNode `json:"previous_leader_node,omitempty"` }
ClusterLeaderFailoverEvent cluster leader failover event swagger:model ClusterLeaderFailoverEvent
type ClusterNode ¶
type ClusterNode struct { // Optional service categories that a node can be assigned (e.g. SYSTEM, INFRASTRUCTURE or ANALYTICS). Field introduced in 18.1.1. Categories []string `json:"categories,omitempty"` // IP address of controller VM. // Required: true IP *IPAddr `json:"ip"` // Name of the object. Name *string `json:"name,omitempty"` // The password we will use when authenticating with this node (Not persisted). Field introduced in 18.2.3. Password *string `json:"password,omitempty"` // Public IP address or hostname of the controller VM. Field introduced in 17.2.3. PublicIPOrName *IPAddr `json:"public_ip_or_name,omitempty"` // Hostname assigned to this controller VM. VMHostname *string `json:"vm_hostname,omitempty"` // Managed object reference of this controller VM. VMMor *string `json:"vm_mor,omitempty"` // Name of the controller VM. VMName *string `json:"vm_name,omitempty"` // UUID on the controller VM. VMUUID *string `json:"vm_uuid,omitempty"` }
ClusterNode cluster node swagger:model ClusterNode
type ClusterNodeAddEvent ¶
type ClusterNodeAddEvent struct { // IP address of the controller VM. IP *IPAddr `json:"ip,omitempty"` // Name of controller node. NodeName *string `json:"node_name,omitempty"` // Role of the controller within the cluster. Enum options - CLUSTER_LEADER, CLUSTER_FOLLOWER. Role *string `json:"role,omitempty"` }
ClusterNodeAddEvent cluster node add event swagger:model ClusterNodeAddEvent
type ClusterNodeDbFailedEvent ¶
type ClusterNodeDbFailedEvent struct { // Number of failures. FailureCount *int32 `json:"failure_count,omitempty"` // IP address of the controller VM. IP *IPAddr `json:"ip,omitempty"` // Name of controller node. NodeName *string `json:"node_name,omitempty"` }
ClusterNodeDbFailedEvent cluster node db failed event swagger:model ClusterNodeDbFailedEvent
type ClusterNodeRemoveEvent ¶
type ClusterNodeRemoveEvent struct { // IP address of the controller VM. IP *IPAddr `json:"ip,omitempty"` // Name of controller node. NodeName *string `json:"node_name,omitempty"` // Role of the node when it left the controller cluster. Enum options - CLUSTER_LEADER, CLUSTER_FOLLOWER. Role *string `json:"role,omitempty"` }
ClusterNodeRemoveEvent cluster node remove event swagger:model ClusterNodeRemoveEvent
type ClusterNodeShutdownEvent ¶
type ClusterNodeShutdownEvent struct { // IP address of the controller VM. IP *IPAddr `json:"ip,omitempty"` // Name of controller node. NodeName *string `json:"node_name,omitempty"` // Reason for controller node shutdown. Reason *string `json:"reason,omitempty"` }
ClusterNodeShutdownEvent cluster node shutdown event swagger:model ClusterNodeShutdownEvent
type ClusterNodeStartedEvent ¶
type ClusterNodeStartedEvent struct { // IP address of the controller VM. IP *IPAddr `json:"ip,omitempty"` // Name of controller node. NodeName *string `json:"node_name,omitempty"` }
ClusterNodeStartedEvent cluster node started event swagger:model ClusterNodeStartedEvent
type ClusterServiceCriticalFailureEvent ¶
type ClusterServiceCriticalFailureEvent struct { // Name of controller node. NodeName *string `json:"node_name,omitempty"` // Name of the controller service. ServiceName *string `json:"service_name,omitempty"` }
ClusterServiceCriticalFailureEvent cluster service critical failure event swagger:model ClusterServiceCriticalFailureEvent
type ClusterServiceFailedEvent ¶
type ClusterServiceFailedEvent struct { // Name of controller node. NodeName *string `json:"node_name,omitempty"` // Name of the controller service. ServiceName *string `json:"service_name,omitempty"` }
ClusterServiceFailedEvent cluster service failed event swagger:model ClusterServiceFailedEvent
type ClusterServiceRestoredEvent ¶
type ClusterServiceRestoredEvent struct { // Name of controller node. NodeName *string `json:"node_name,omitempty"` // Name of the controller service. ServiceName *string `json:"service_name,omitempty"` }
ClusterServiceRestoredEvent cluster service restored event swagger:model ClusterServiceRestoredEvent
type ClusterWarmRebootEvent ¶
type ClusterWarmRebootEvent interface{}
ClusterWarmRebootEvent cluster warm reboot event swagger:model ClusterWarmRebootEvent
type CompressionFilter ¶
type CompressionFilter struct { // It is a reference to an object of type StringGroup. DevicesRef *string `json:"devices_ref,omitempty"` // Number of index. // Required: true Index *int32 `json:"index"` // Placeholder for description of property ip_addr_prefixes of obj type CompressionFilter field type str type object IPAddrPrefixes []*IPAddrPrefix `json:"ip_addr_prefixes,omitempty"` // Placeholder for description of property ip_addr_ranges of obj type CompressionFilter field type str type object IPAddrRanges []*IPAddrRange `json:"ip_addr_ranges,omitempty"` // Placeholder for description of property ip_addrs of obj type CompressionFilter field type str type object IPAddrs []*IPAddr `json:"ip_addrs,omitempty"` // It is a reference to an object of type IpAddrGroup. IPAddrsRef *string `json:"ip_addrs_ref,omitempty"` // Enum options - AGGRESSIVE_COMPRESSION, NORMAL_COMPRESSION, NO_COMPRESSION. // Required: true Level *string `json:"level"` // Whether to apply Filter when group criteria is matched or not. Enum options - IS_IN, IS_NOT_IN. Match *string `json:"match,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // user_agent of CompressionFilter. UserAgent []string `json:"user_agent,omitempty"` }
CompressionFilter compression filter swagger:model CompressionFilter
type CompressionProfile ¶
type CompressionProfile struct { // Compress only content types listed in this *string group. Content types not present in this list are not compressed. It is a reference to an object of type StringGroup. CompressibleContentRef *string `json:"compressible_content_ref,omitempty"` // Compress HTTP response content if it wasn't already compressed. // Required: true Compression *bool `json:"compression"` // Custom filters used when auto compression is not selected. Filter []*CompressionFilter `json:"filter,omitempty"` // Offload compression from the servers to AVI. Saves compute cycles on the servers. // Required: true RemoveAcceptEncodingHeader *bool `json:"remove_accept_encoding_header"` // Compress content automatically or add custom filters to define compressible content and compression levels. Enum options - AUTO_COMPRESSION, CUSTOM_COMPRESSION. // Required: true Type *string `json:"type"` }
CompressionProfile compression profile swagger:model CompressionProfile
type ConfigActionDetails ¶
type ConfigActionDetails struct { // Name of the action. ActionName *string `json:"action_name,omitempty"` // Error message if request failed. ErrorMessage *string `json:"error_message,omitempty"` // Parameter data. ParameterData *string `json:"parameter_data,omitempty"` // API path. Path *string `json:"path,omitempty"` // Name of the resource. ResourceName *string `json:"resource_name,omitempty"` // Config type of the resource. ResourceType *string `json:"resource_type,omitempty"` // Status. Status *string `json:"status,omitempty"` // Request user. User *string `json:"user,omitempty"` }
ConfigActionDetails config action details swagger:model ConfigActionDetails
type ConfigCreateDetails ¶
type ConfigCreateDetails struct { // Error message if request failed. ErrorMessage *string `json:"error_message,omitempty"` // API path. Path *string `json:"path,omitempty"` // Request data if request failed. RequestData *string `json:"request_data,omitempty"` // Data of the created resource. ResourceData *string `json:"resource_data,omitempty"` // Name of the created resource. ResourceName *string `json:"resource_name,omitempty"` // Config type of the created resource. ResourceType *string `json:"resource_type,omitempty"` // Status. Status *string `json:"status,omitempty"` // Request user. User *string `json:"user,omitempty"` }
ConfigCreateDetails config create details swagger:model ConfigCreateDetails
type ConfigDeleteDetails ¶
type ConfigDeleteDetails struct { // Error message if request failed. ErrorMessage *string `json:"error_message,omitempty"` // API path. Path *string `json:"path,omitempty"` // Deleted data of the resource. ResourceData *string `json:"resource_data,omitempty"` // Name of the deleted resource. ResourceName *string `json:"resource_name,omitempty"` // Config type of the deleted resource. ResourceType *string `json:"resource_type,omitempty"` // Status. Status *string `json:"status,omitempty"` // Request user. User *string `json:"user,omitempty"` }
ConfigDeleteDetails config delete details swagger:model ConfigDeleteDetails
type ConfigInfo ¶
type ConfigInfo struct { // Placeholder for description of property queue of obj type ConfigInfo field type str type object Queue []*VersionInfo `json:"queue,omitempty"` // Number of reader_count. ReaderCount *int32 `json:"reader_count,omitempty"` // Enum options - REPL_NONE, REPL_ENABLED, REPL_DISABLED. State *string `json:"state,omitempty"` // Number of writer_count. WriterCount *int32 `json:"writer_count,omitempty"` }
ConfigInfo config info swagger:model ConfigInfo
type ConfigSeGrpFlvUpdate ¶
type ConfigSeGrpFlvUpdate struct { // New Flavor Name. NewFlv *string `json:"new_flv,omitempty"` // Old Flavor Name. OldFlv *string `json:"old_flv,omitempty"` // SE Group Name. SeGroupName *string `json:"se_group_name,omitempty"` // SE Group UUID. SeGroupUUID *string `json:"se_group_uuid,omitempty"` // Tenant Name. TenantName *string `json:"tenant_name,omitempty"` // Tenant UUID. TenantUUID *string `json:"tenant_uuid,omitempty"` }
ConfigSeGrpFlvUpdate config se grp flv update swagger:model ConfigSeGrpFlvUpdate
type ConfigUpdateDetails ¶
type ConfigUpdateDetails struct { // Error message if request failed. ErrorMessage *string `json:"error_message,omitempty"` // New updated data of the resource. NewResourceData *string `json:"new_resource_data,omitempty"` // Old & overwritten data of the resource. OldResourceData *string `json:"old_resource_data,omitempty"` // API path. Path *string `json:"path,omitempty"` // Request data if request failed. RequestData *string `json:"request_data,omitempty"` // Name of the created resource. ResourceName *string `json:"resource_name,omitempty"` // Config type of the updated resource. ResourceType *string `json:"resource_type,omitempty"` // Status. Status *string `json:"status,omitempty"` // Request user. User *string `json:"user,omitempty"` }
ConfigUpdateDetails config update details swagger:model ConfigUpdateDetails
type ConfigUserAuthrzByRule ¶
type ConfigUserAuthrzByRule struct { // Comma separated list of policies assigned to the user. Field introduced in 18.2.7, 20.1.1. Policies *string `json:"policies,omitempty"` // assigned roles. Roles *string `json:"roles,omitempty"` // matching rule string. Rule *string `json:"rule,omitempty"` // assigned tenants. Tenants *string `json:"tenants,omitempty"` // Request user. User *string `json:"user,omitempty"` // assigned user account profile name. Field introduced in 20.1.3. Userprofile *string `json:"userprofile,omitempty"` }
ConfigUserAuthrzByRule config user authrz by rule swagger:model ConfigUserAuthrzByRule
type ConfigUserLogin ¶
type ConfigUserLogin struct { // client ip. ClientIP *string `json:"client_ip,omitempty"` // Type of client used to login UI, CLI, others(API). Field introduced in 20.1.3. ClientType *string `json:"client_type,omitempty"` // error message if authentication failed. ErrorMessage *string `json:"error_message,omitempty"` // Local user. Field introduced in 17.1.1. Local *bool `json:"local,omitempty"` // Additional attributes from login handler. Field introduced in 18.1.4,18.2.1. RemoteAttributes *string `json:"remote_attributes,omitempty"` // Status. Status *string `json:"status,omitempty"` // Request user. User *string `json:"user,omitempty"` }
ConfigUserLogin config user login swagger:model ConfigUserLogin
type ConfigUserLogout ¶
type ConfigUserLogout struct { // client ip. ClientIP *string `json:"client_ip,omitempty"` // error message if logging out failed. ErrorMessage *string `json:"error_message,omitempty"` // Local user. Field introduced in 17.1.1. Local *bool `json:"local,omitempty"` // Status. Status *string `json:"status,omitempty"` // Request user. User *string `json:"user,omitempty"` }
ConfigUserLogout config user logout swagger:model ConfigUserLogout
type ConfigUserNotAuthrzByRule ¶
type ConfigUserNotAuthrzByRule struct { // Comma separated list of policies assigned to the user. Field introduced in 18.2.7, 20.1.1. Policies *string `json:"policies,omitempty"` // assigned roles. Roles *string `json:"roles,omitempty"` // assigned tenants. Tenants *string `json:"tenants,omitempty"` // Request user. User *string `json:"user,omitempty"` }
ConfigUserNotAuthrzByRule config user not authrz by rule swagger:model ConfigUserNotAuthrzByRule
type ConfigUserPasswordChangeRequest ¶
type ConfigUserPasswordChangeRequest struct { // client ip. ClientIP *string `json:"client_ip,omitempty"` // Password link is sent or rejected. Status *string `json:"status,omitempty"` // Matched username of email address. User *string `json:"user,omitempty"` // Email address of user. UserEmail *string `json:"user_email,omitempty"` }
ConfigUserPasswordChangeRequest config user password change request swagger:model ConfigUserPasswordChangeRequest
type ConnErrorInfo ¶
type ConnErrorInfo struct { // Number of num_syn_retransmit. NumSynRetransmit *int32 `json:"num_syn_retransmit,omitempty"` // Number of num_window_shrink. NumWindowShrink *int32 `json:"num_window_shrink,omitempty"` // Number of out_of_orders. OutOfOrders *int32 `json:"out_of_orders,omitempty"` // Number of retransmits. Retransmits *int32 `json:"retransmits,omitempty"` // Number of rx_pkts. RxPkts *int64 `json:"rx_pkts,omitempty"` // Number of server_num_window_shrink. ServerNumWindowShrink *int32 `json:"server_num_window_shrink,omitempty"` // Number of server_out_of_orders. ServerOutOfOrders *int32 `json:"server_out_of_orders,omitempty"` // Number of server_retransmits. ServerRetransmits *int32 `json:"server_retransmits,omitempty"` // Number of server_rx_pkts. ServerRxPkts *int64 `json:"server_rx_pkts,omitempty"` // Number of server_timeouts. ServerTimeouts *int32 `json:"server_timeouts,omitempty"` // Number of server_tx_pkts. ServerTxPkts *int64 `json:"server_tx_pkts,omitempty"` // Number of server_zero_window_size_events. ServerZeroWindowSizeEvents *int64 `json:"server_zero_window_size_events,omitempty"` // Number of timeouts. Timeouts *int32 `json:"timeouts,omitempty"` // Number of tx_pkts. TxPkts *int64 `json:"tx_pkts,omitempty"` // Number of zero_window_size_events. ZeroWindowSizeEvents *int64 `json:"zero_window_size_events,omitempty"` }
ConnErrorInfo conn error info swagger:model ConnErrorInfo
type ConnPoolProperties ¶
type ConnPoolProperties struct { // Connection idle timeout. Field introduced in 18.2.1. Allowed in Basic(Allowed values- 60000) edition, Essentials(Allowed values- 60000) edition, Enterprise edition. UpstreamConnpoolConnIDLETmo *int32 `json:"upstream_connpool_conn_idle_tmo,omitempty"` // Connection life timeout. Field introduced in 18.2.1. Allowed in Basic(Allowed values- 600000) edition, Essentials(Allowed values- 600000) edition, Enterprise edition. UpstreamConnpoolConnLifeTmo *int32 `json:"upstream_connpool_conn_life_tmo,omitempty"` // Maximum number of times a connection can be reused. Special values are 0- 'unlimited'. Field introduced in 18.2.1. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. UpstreamConnpoolConnMaxReuse *int32 `json:"upstream_connpool_conn_max_reuse,omitempty"` // Maximum number of connections a server can cache. Special values are 0- 'unlimited'. Field introduced in 18.2.1. UpstreamConnpoolServerMaxCache *int32 `json:"upstream_connpool_server_max_cache,omitempty"` }
ConnPoolProperties conn pool properties swagger:model ConnPoolProperties
type ConnectionClearFilter ¶
type ConnectionClearFilter struct { // IP address in dotted decimal notation. IPAddr *string `json:"ip_addr,omitempty"` // Port number. Port *int32 `json:"port,omitempty"` }
ConnectionClearFilter connection clear filter swagger:model ConnectionClearFilter
type ConnectionLog ¶
type ConnectionLog struct { // Placeholder for description of property adf of obj type ConnectionLog field type str type boolean // Required: true Adf *bool `json:"adf"` // Unit is MILLISECONDS. AverageTurntime *int32 `json:"average_turntime,omitempty"` // Number of client_dest_port. // Required: true ClientDestPort *int32 `json:"client_dest_port"` // Number of client_ip. // Required: true ClientIP *int32 `json:"client_ip"` // IPv6 address of the client. Field introduced in 18.1.1. ClientIp6 *string `json:"client_ip6,omitempty"` // client_location of ConnectionLog. ClientLocation *string `json:"client_location,omitempty"` // Name of the Client Log Filter applied. Field introduced in 18.1.5, 18.2.1. ClientLogFilterName *string `json:"client_log_filter_name,omitempty"` // Unit is MILLISECONDS. // Required: true ClientRtt *int32 `json:"client_rtt"` // Number of client_src_port. // Required: true ClientSrcPort *int32 `json:"client_src_port"` // Placeholder for description of property connection_ended of obj type ConnectionLog field type str type boolean // Required: true ConnectionEnded *bool `json:"connection_ended"` // Enum options - DNS_ENTRY_PASS_THROUGH, DNS_ENTRY_GSLB, DNS_ENTRY_VIRTUALSERVICE, DNS_ENTRY_STATIC, DNS_ENTRY_POLICY, DNS_ENTRY_LOCAL. DNSEtype *string `json:"dns_etype,omitempty"` // dns_fqdn of ConnectionLog. DNSFqdn *string `json:"dns_fqdn,omitempty"` // Number of dns_ips. DNSIps []int64 `json:"dns_ips,omitempty,omitempty"` // Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. DNSQtype *string `json:"dns_qtype,omitempty"` // Field introduced in 17.1.1. DNSRequest *DNSRequest `json:"dns_request,omitempty"` // Placeholder for description of property dns_response of obj type ConnectionLog field type str type object DNSResponse *DNSResponse `json:"dns_response,omitempty"` // Datascript Log. Field introduced in 18.2.3. DsLog *string `json:"ds_log,omitempty"` // gslbpool_name of ConnectionLog. GslbpoolName *string `json:"gslbpool_name,omitempty"` // gslbservice of ConnectionLog. Gslbservice *string `json:"gslbservice,omitempty"` // gslbservice_name of ConnectionLog. GslbserviceName *string `json:"gslbservice_name,omitempty"` // Number of log_id. // Required: true LogID *int32 `json:"log_id"` // microservice of ConnectionLog. Microservice *string `json:"microservice,omitempty"` // microservice_name of ConnectionLog. MicroserviceName *string `json:"microservice_name,omitempty"` // Unit is BYTES. // Required: true Mss *int32 `json:"mss"` // network_security_policy_rule_name of ConnectionLog. NetworkSecurityPolicyRuleName *string `json:"network_security_policy_rule_name,omitempty"` // Number of num_syn_retransmit. NumSynRetransmit *int32 `json:"num_syn_retransmit,omitempty"` // Number of num_transaction. NumTransaction *int32 `json:"num_transaction,omitempty"` // Number of num_window_shrink. NumWindowShrink *int32 `json:"num_window_shrink,omitempty"` // OCSP Response sent in the SSL/TLS connection Handshake. Field introduced in 20.1.1. OcspStatusRespSent *bool `json:"ocsp_status_resp_sent,omitempty"` // Number of out_of_orders. // Required: true OutOfOrders *int32 `json:"out_of_orders"` // Persistence applied during server selection. Field introduced in 20.1.1. PersistenceUsed *bool `json:"persistence_used,omitempty"` // pool of ConnectionLog. Pool *string `json:"pool,omitempty"` // pool_name of ConnectionLog. PoolName *string `json:"pool_name,omitempty"` // Enum options - PROTOCOL_ICMP, PROTOCOL_TCP, PROTOCOL_UDP. Protocol *string `json:"protocol,omitempty"` // Version of proxy protocol used to convey client connection information to the back-end servers. A value of 0 indicates that proxy protocol is not used. A value of 1 or 2 indicates the version of proxy protocol used. Enum options - PROXY_PROTOCOL_VERSION_1, PROXY_PROTOCOL_VERSION_2. ProxyProtocol *string `json:"proxy_protocol,omitempty"` // Number of report_timestamp. // Required: true ReportTimestamp *int64 `json:"report_timestamp"` // Number of retransmits. // Required: true Retransmits *int32 `json:"retransmits"` // Unit is BYTES. // Required: true RxBytes *int64 `json:"rx_bytes"` // Number of rx_pkts. // Required: true RxPkts *int64 `json:"rx_pkts"` // Number of server_conn_src_ip. // Required: true ServerConnSrcIP *int32 `json:"server_conn_src_ip"` // IPv6 address used to connect to Backend Server. Field introduced in 18.1.1. ServerConnSrcIp6 *string `json:"server_conn_src_ip6,omitempty"` // Number of server_dest_port. // Required: true ServerDestPort *int32 `json:"server_dest_port"` // Number of server_ip. // Required: true ServerIP *int32 `json:"server_ip"` // IPv6 address of the Backend Server. Field introduced in 18.1.1. ServerIp6 *string `json:"server_ip6,omitempty"` // server_name of ConnectionLog. ServerName *string `json:"server_name,omitempty"` // Number of server_num_window_shrink. ServerNumWindowShrink *int32 `json:"server_num_window_shrink,omitempty"` // Number of server_out_of_orders. // Required: true ServerOutOfOrders *int32 `json:"server_out_of_orders"` // Number of server_retransmits. // Required: true ServerRetransmits *int32 `json:"server_retransmits"` // Unit is MILLISECONDS. // Required: true ServerRtt *int32 `json:"server_rtt"` // Unit is BYTES. // Required: true ServerRxBytes *int64 `json:"server_rx_bytes"` // Number of server_rx_pkts. // Required: true ServerRxPkts *int64 `json:"server_rx_pkts"` // Number of server_src_port. // Required: true ServerSrcPort *int32 `json:"server_src_port"` // Number of server_timeouts. // Required: true ServerTimeouts *int32 `json:"server_timeouts"` // Unit is BYTES. // Required: true ServerTotalBytes *int64 `json:"server_total_bytes"` // Number of server_total_pkts. // Required: true ServerTotalPkts *int64 `json:"server_total_pkts"` // Unit is BYTES. // Required: true ServerTxBytes *int64 `json:"server_tx_bytes"` // Number of server_tx_pkts. // Required: true ServerTxPkts *int64 `json:"server_tx_pkts"` // Number of server_zero_window_size_events. // Required: true ServerZeroWindowSizeEvents *int32 `json:"server_zero_window_size_events"` // service_engine of ConnectionLog. ServiceEngine *string `json:"service_engine,omitempty"` // significance of ConnectionLog. Significance *string `json:"significance,omitempty"` // Number of significant. // Required: true Significant *int64 `json:"significant"` // List of enums which indicate why a log is significant. Enum options - ADF_CLIENT_CONN_SETUP_REFUSED, ADF_SERVER_CONN_SETUP_REFUSED, ADF_CLIENT_CONN_SETUP_TIMEDOUT, ADF_SERVER_CONN_SETUP_TIMEDOUT, ADF_CLIENT_CONN_SETUP_FAILED_INTERNAL, ADF_SERVER_CONN_SETUP_FAILED_INTERNAL, ADF_CLIENT_CONN_SETUP_FAILED_BAD_PACKET, ADF_UDP_CONN_SETUP_FAILED_INTERNAL, ADF_UDP_SERVER_CONN_SETUP_FAILED_INTERNAL, ADF_CLIENT_SENT_RESET, ADF_SERVER_SENT_RESET, ADF_CLIENT_CONN_TIMEDOUT, ADF_SERVER_CONN_TIMEDOUT, ADF_USER_DELETE_OPERATION, ADF_CLIENT_REQUEST_TIMEOUT, ADF_CLIENT_CONN_ABORTED, ADF_CLIENT_SSL_HANDSHAKE_FAILURE, ADF_CLIENT_CONN_FAILED, ADF_SERVER_CERTIFICATE_VERIFICATION_FAILED, ADF_SERVER_SIDE_SSL_HANDSHAKE_FAILED... SignificantLog []string `json:"significant_log,omitempty"` // SIP related logging information. Field introduced in 17.2.12, 18.1.3, 18.2.1. SipLog *SipLog `json:"sip_log,omitempty"` // Field introduced in 17.2.5. SniHostname *string `json:"sni_hostname,omitempty"` // ssl_cipher of ConnectionLog. SslCipher *string `json:"ssl_cipher,omitempty"` // ssl_session_id of ConnectionLog. SslSessionID *string `json:"ssl_session_id,omitempty"` // ssl_version of ConnectionLog. SslVersion *string `json:"ssl_version,omitempty"` // Number of start_timestamp. // Required: true StartTimestamp *int64 `json:"start_timestamp"` // Number of timeouts. // Required: true Timeouts *int32 `json:"timeouts"` // Unit is BYTES. TotalBytes *int64 `json:"total_bytes,omitempty"` // Number of total_pkts. TotalPkts *int64 `json:"total_pkts,omitempty"` // Unit is MILLISECONDS. TotalTime *int64 `json:"total_time,omitempty"` // Unit is BYTES. // Required: true TxBytes *int64 `json:"tx_bytes"` // Number of tx_pkts. // Required: true TxPkts *int64 `json:"tx_pkts"` // Placeholder for description of property udf of obj type ConnectionLog field type str type boolean // Required: true Udf *bool `json:"udf"` // Number of vcpu_id. // Required: true VcpuID *int32 `json:"vcpu_id"` // virtualservice of ConnectionLog. // Required: true Virtualservice *string `json:"virtualservice"` // Field introduced in 17.1.1. VsIP *int32 `json:"vs_ip,omitempty"` // IPv6 address of the VIP of the VS. Field introduced in 18.1.1. VsIp6 *string `json:"vs_ip6,omitempty"` // Number of zero_window_size_events. // Required: true ZeroWindowSizeEvents *int32 `json:"zero_window_size_events"` }
ConnectionLog connection log swagger:model ConnectionLog
type ConnpoolFilter ¶
type ConnpoolFilter struct { // Backend or SE IP address. IPAddr *string `json:"ip_addr,omitempty"` // Backend or SE IP address mask. IPMask *string `json:"ip_mask,omitempty"` // Backend or SE port. Port *int32 `json:"port,omitempty"` // cache type. Enum options - CP_ALL, CP_FREE, CP_BIND, CP_CACHED. Type *string `json:"type,omitempty"` }
ConnpoolFilter connpool filter swagger:model ConnpoolFilter
type ContainerCloudBatchSetup ¶
type ContainerCloudBatchSetup struct { // Placeholder for description of property ccs of obj type ContainerCloudBatchSetup field type str type object Ccs []*ContainerCloudSetup `json:"ccs,omitempty"` }
ContainerCloudBatchSetup container cloud batch setup swagger:model ContainerCloudBatchSetup
type ContainerCloudService ¶
type ContainerCloudService struct { // cc_id of ContainerCloudService. CcID *string `json:"cc_id,omitempty"` // object of ContainerCloudService. Object *string `json:"object,omitempty"` // reason of ContainerCloudService. Reason *string `json:"reason,omitempty"` // service of ContainerCloudService. Service *string `json:"service,omitempty"` // status of ContainerCloudService. Status *string `json:"status,omitempty"` }
ContainerCloudService container cloud service swagger:model ContainerCloudService
type ContainerCloudSetup ¶
type ContainerCloudSetup struct { // cc_id of ContainerCloudSetup. CcID *string `json:"cc_id,omitempty"` // Placeholder for description of property cloud_access of obj type ContainerCloudSetup field type str type boolean CloudAccess *bool `json:"cloud_access,omitempty"` // failed_hosts of ContainerCloudSetup. FailedHosts []string `json:"failed_hosts,omitempty"` // fleet_endpoint of ContainerCloudSetup. FleetEndpoint *string `json:"fleet_endpoint,omitempty"` // hosts of ContainerCloudSetup. Hosts []string `json:"hosts,omitempty"` // master_nodes of ContainerCloudSetup. MasterNodes []string `json:"master_nodes,omitempty"` // missing_hosts of ContainerCloudSetup. MissingHosts []string `json:"missing_hosts,omitempty"` // new_hosts of ContainerCloudSetup. NewHosts []string `json:"new_hosts,omitempty"` // reason of ContainerCloudSetup. Reason *string `json:"reason,omitempty"` // Placeholder for description of property se_deploy_method_access of obj type ContainerCloudSetup field type str type boolean SeDeployMethodAccess *bool `json:"se_deploy_method_access,omitempty"` // se_name of ContainerCloudSetup. SeName *string `json:"se_name,omitempty"` // version of ContainerCloudSetup. Version *string `json:"version,omitempty"` }
ContainerCloudSetup container cloud setup swagger:model ContainerCloudSetup
type ContentLibConfig ¶
type ContentLibConfig struct { // Content Library Id. Field introduced in 20.1.1. ID *string `json:"id,omitempty"` // Content Library name. Field introduced in 20.1.1. Name *string `json:"name,omitempty"` }
ContentLibConfig content lib config swagger:model ContentLibConfig
type ContentRewriteProfile ¶
type ContentRewriteProfile struct { // Strings to be matched and replaced with on the request body. This should be configured when request_rewrite_enabled is set to true. This is currently not supported. ReqMatchReplacePair []*MatchReplacePair `json:"req_match_replace_pair,omitempty"` // Enable rewrite on request body. This is not currently supported. RequestRewriteEnabled *bool `json:"request_rewrite_enabled,omitempty"` // Enable rewrite on response body. ResponseRewriteEnabled *bool `json:"response_rewrite_enabled,omitempty"` // Rewrite only content types listed in this *string group. Content types not present in this list are not rewritten. It is a reference to an object of type StringGroup. RewritableContentRef *string `json:"rewritable_content_ref,omitempty"` // Strings to be matched and replaced with on the response body. This should be configured when response_rewrite_enabled is set to true. RspMatchReplacePair []*MatchReplacePair `json:"rsp_match_replace_pair,omitempty"` }
ContentRewriteProfile content rewrite profile swagger:model ContentRewriteProfile
type ControllerCloudLimits ¶
type ControllerCloudLimits struct { // Maximum number of clouds of a given type. Field introduced in 20.1.1. NumClouds *int32 `json:"num_clouds,omitempty"` // Cloud type for the limit. Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Field introduced in 20.1.1. Type *string `json:"type,omitempty"` }
ControllerCloudLimits controller cloud limits swagger:model ControllerCloudLimits
type ControllerDiscontinuousTimeChangeEventDetails ¶
type ControllerDiscontinuousTimeChangeEventDetails struct { // Time stamp before the discontinuous jump in time. FromTime *string `json:"from_time,omitempty"` // Name of the Controller responsible for this event. NodeName *string `json:"node_name,omitempty"` // Time stamp to which the time has discontinuously jumped. ToTime *string `json:"to_time,omitempty"` }
ControllerDiscontinuousTimeChangeEventDetails controller discontinuous time change event details swagger:model ControllerDiscontinuousTimeChangeEventDetails
type ControllerLicenseReconcileDetails ¶
type ControllerLicenseReconcileDetails struct { // Placeholder for description of property new_available_service_cores of obj type ControllerLicenseReconcileDetails field type str type number NewAvailableServiceCores *float64 `json:"new_available_service_cores,omitempty"` // Placeholder for description of property new_consumed_service_cores of obj type ControllerLicenseReconcileDetails field type str type number NewConsumedServiceCores *float64 `json:"new_consumed_service_cores,omitempty"` // Placeholder for description of property new_escrow_service_cores of obj type ControllerLicenseReconcileDetails field type str type number NewEscrowServiceCores *float64 `json:"new_escrow_service_cores,omitempty"` // Placeholder for description of property new_remaining_service_cores of obj type ControllerLicenseReconcileDetails field type str type number NewRemainingServiceCores *float64 `json:"new_remaining_service_cores,omitempty"` // Placeholder for description of property old_available_service_cores of obj type ControllerLicenseReconcileDetails field type str type number OldAvailableServiceCores *float64 `json:"old_available_service_cores,omitempty"` // Placeholder for description of property old_consumed_service_cores of obj type ControllerLicenseReconcileDetails field type str type number OldConsumedServiceCores *float64 `json:"old_consumed_service_cores,omitempty"` // Placeholder for description of property old_escrow_service_cores of obj type ControllerLicenseReconcileDetails field type str type number OldEscrowServiceCores *float64 `json:"old_escrow_service_cores,omitempty"` // Placeholder for description of property old_remaining_service_cores of obj type ControllerLicenseReconcileDetails field type str type number OldRemainingServiceCores *float64 `json:"old_remaining_service_cores,omitempty"` // Unique object identifier of tenant. TenantUUID *string `json:"tenant_uuid,omitempty"` // tier of ControllerLicenseReconcileDetails. Tier *string `json:"tier,omitempty"` }
ControllerLicenseReconcileDetails controller license reconcile details swagger:model ControllerLicenseReconcileDetails
type ControllerLimits ¶
type ControllerLimits struct { // Maximum number of certificates per virtualservice. Field introduced in 20.1.1. CertificatesPerVirtualservice *int32 `json:"certificates_per_virtualservice,omitempty"` // Controller system limits specific to cloud type for all controller sizes. Field introduced in 20.1.1. ControllerCloudLimits []*ControllerCloudLimits `json:"controller_cloud_limits,omitempty"` // Controller system limits specific to controller sizing. Field introduced in 20.1.1. Maximum of 3 items allowed. ControllerSizingLimits []*ControllerSizingLimits `json:"controller_sizing_limits,omitempty"` // Maximum number of default routes per vrfcontext. Field introduced in 20.1.1. DefaultRoutesPerVrfcontext *int32 `json:"default_routes_per_vrfcontext,omitempty"` // Maximum number of IP's per ipaddrgroup. Field introduced in 20.1.1. IpsPerIpgroup *int32 `json:"ips_per_ipgroup,omitempty"` // Maximum number of poolgroups per virtualservice. Field introduced in 20.1.1. PoolgroupsPerVirtualservice *int32 `json:"poolgroups_per_virtualservice,omitempty"` // Maximum number of pools per poolgroup. Field introduced in 20.1.1. PoolsPerPoolgroup *int32 `json:"pools_per_poolgroup,omitempty"` // Maximum number of pools per virtualservice. Field introduced in 20.1.1. PoolsPerVirtualservice *int32 `json:"pools_per_virtualservice,omitempty"` // Maximum number of routes per vrfcontext. Field introduced in 20.1.1. RoutesPerVrfcontext *int32 `json:"routes_per_vrfcontext,omitempty"` // Maximum number of rules per httppolicy. Field introduced in 20.1.1. RulesPerHttppolicy *int32 `json:"rules_per_httppolicy,omitempty"` // Maximum number of rules per networksecuritypolicy. Field introduced in 20.1.1. RulesPerNetworksecuritypolicy *int32 `json:"rules_per_networksecuritypolicy,omitempty"` // Maximum number of servers per pool. Field introduced in 20.1.1. ServersPerPool *int32 `json:"servers_per_pool,omitempty"` // Maximum number of SNI children virtualservices per SNI parent virtualservice. Field introduced in 20.1.1. SniChildrenPerParent *int32 `json:"sni_children_per_parent,omitempty"` // Maximum number of strings per stringgroup. Field introduced in 20.1.1. StringsPerStringgroup *int32 `json:"strings_per_stringgroup,omitempty"` // Maximum number of serviceengine per virtualservice in bgp scaleout mode. Field introduced in 20.1.1. VsBgpScaleout *int32 `json:"vs_bgp_scaleout,omitempty"` // Maximum number of serviceengine per virtualservice in layer 2 scaleout mode. Field introduced in 20.1.1. VsL2Scaleout *int32 `json:"vs_l2_scaleout,omitempty"` }
ControllerLimits controller limits swagger:model ControllerLimits
type ControllerPortalAsset ¶
type ControllerPortalAsset struct { // Asset ID corresponding to this Controller Cluster, returned on a successful registration. Field introduced in 18.2.6. AssetID *string `json:"asset_id,omitempty"` }
ControllerPortalAsset controller portal asset swagger:model ControllerPortalAsset
type ControllerPortalAuth ¶
type ControllerPortalAuth struct { // Access Token to authenticate Customer Portal REST calls. Field introduced in 18.2.6. AccessToken *string `json:"access_token,omitempty"` // Salesforce instance URL. Field introduced in 18.2.6. InstanceURL *string `json:"instance_url,omitempty"` // Signed JWT to refresh the access token. Field introduced in 18.2.6. JwtToken *string `json:"jwt_token,omitempty"` }
ControllerPortalAuth controller portal auth swagger:model ControllerPortalAuth
type ControllerPortalRegistration ¶
type ControllerPortalRegistration struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Field introduced in 18.2.6. Asset *ControllerPortalAsset `json:"asset,omitempty"` // Field introduced in 18.2.6. // Required: true Name *string `json:"name"` // Field introduced in 18.2.6. PortalAuth *ControllerPortalAuth `json:"portal_auth,omitempty"` // It is a reference to an object of type Tenant. Field introduced in 18.2.6. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 18.2.6. UUID *string `json:"uuid,omitempty"` }
ControllerPortalRegistration controller portal registration swagger:model ControllerPortalRegistration
type ControllerPortalRegistrationAPIResponse ¶
type ControllerPortalRegistrationAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ControllerPortalRegistration `json:"results,omitempty"` }
ControllerPortalRegistrationAPIResponse controller portal registration Api response swagger:model ControllerPortalRegistrationApiResponse
type ControllerProperties ¶
type ControllerProperties struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Allow non-admin tenants to update admin VrfContext and Network objects. Field introduced in 18.2.7, 20.1.1. AllowAdminNetworkUpdates *bool `json:"allow_admin_network_updates,omitempty"` // Field introduced in 17.1.1. AllowIPForwarding *bool `json:"allow_ip_forwarding,omitempty"` // Allow unauthenticated access for special APIs. AllowUnauthenticatedApis *bool `json:"allow_unauthenticated_apis,omitempty"` // Placeholder for description of property allow_unauthenticated_nodes of obj type ControllerProperties field type str type boolean AllowUnauthenticatedNodes *bool `json:"allow_unauthenticated_nodes,omitempty"` // Allowed values are 0-1440. Unit is MIN. APIIDLETimeout *int32 `json:"api_idle_timeout,omitempty"` // Threshold to log request timing in portal_performance.log and Server-Timing response header. Any stage taking longer than 1% of the threshold will be included in the Server-Timing header. Field introduced in 18.1.4, 18.2.1. Unit is MILLISECONDS. APIPerfLoggingThreshold *int32 `json:"api_perf_logging_threshold,omitempty"` // Export configuration in appviewx compatibility mode. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AppviewxCompatMode *bool `json:"appviewx_compat_mode,omitempty"` // Period for which asynchronous patch requests are queued. Allowed values are 30-120. Special values are 0 - 'Deactivated'. Field introduced in 18.2.11, 20.1.3. Unit is SEC. AsyncPatchMergePeriod *int32 `json:"async_patch_merge_period,omitempty"` // Duration for which asynchronous patch requests should be kept, after being marked as SUCCESS or FAIL. Allowed values are 5-120. Field introduced in 18.2.11, 20.1.3. Unit is MIN. AsyncPatchRequestCleanupDuration *int32 `json:"async_patch_request_cleanup_duration,omitempty"` // Unit is SEC. AttachIPRetryInterval *int32 `json:"attach_ip_retry_interval,omitempty"` // Number of attach_ip_retry_limit. AttachIPRetryLimit *int32 `json:"attach_ip_retry_limit,omitempty"` // Use Ansible for SE creation in baremetal. Field introduced in 17.2.2. BmUseAnsible *bool `json:"bm_use_ansible,omitempty"` // Period for auth token cleanup job. Field introduced in 18.1.1. Unit is MIN. CleanupExpiredAuthtokenTimeoutPeriod *int32 `json:"cleanup_expired_authtoken_timeout_period,omitempty"` // Period for sessions cleanup job. Field introduced in 18.1.1. Unit is MIN. CleanupSessionsTimeoutPeriod *int32 `json:"cleanup_sessions_timeout_period,omitempty"` // Enable/Disable periodic reconcile for all the clouds. Field introduced in 17.2.14,18.1.5,18.2.1. CloudReconcile *bool `json:"cloud_reconcile,omitempty"` // Period for cluster ip gratuitous arp job. Unit is MIN. ClusterIPGratuitousArpPeriod *int32 `json:"cluster_ip_gratuitous_arp_period,omitempty"` // Period for consistency check job. Field introduced in 18.1.1. Unit is MIN. ConsistencyCheckTimeoutPeriod *int32 `json:"consistency_check_timeout_period,omitempty"` // Periodically collect stats. Field introduced in 20.1.3. Unit is MIN. ControllerResourceInfoCollectionPeriod *int32 `json:"controller_resource_info_collection_period,omitempty"` // Unit is SEC. CrashedSeReboot *int32 `json:"crashed_se_reboot,omitempty"` // Unit is SEC. DeadSeDetectionTimer *int32 `json:"dead_se_detection_timer,omitempty"` // Minimum api timeout value.If this value is not 60, it will be the default timeout for all APIs that do not have a specific timeout.If an API has a specific timeout but is less than this value, this value will become the new timeout. Allowed values are 60-3600. Field introduced in 18.2.6. Unit is SEC. DefaultMinimumAPITimeout *int32 `json:"default_minimum_api_timeout,omitempty"` // Period for refresh pool and gslb DNS job. Unit is MIN. Allowed in Basic(Allowed values- 60) edition, Essentials(Allowed values- 60) edition, Enterprise edition. DNSRefreshPeriod *int32 `json:"dns_refresh_period,omitempty"` // Number of dummy. Dummy *int32 `json:"dummy,omitempty"` // Allow editing of system limits. Keep in mind that these system limits have been carefully selected based on rigorous testing in our testig environments. Modifying these limits could destabilize your cluster. Do this at your own risk!. Field introduced in 20.1.1. EditSystemLimits *bool `json:"edit_system_limits,omitempty"` // This setting enables the controller leader to shard API requests to the followers (if any). Field introduced in 18.1.5, 18.2.1. EnableAPISharding *bool `json:"enable_api_sharding,omitempty"` // Enable/Disable Memory Balancer. Field introduced in 17.2.8. EnableMemoryBalancer *bool `json:"enable_memory_balancer,omitempty"` // Unit is SEC. FatalErrorLeaseTime *int32 `json:"fatal_error_lease_time,omitempty"` // Federated datastore will not cleanup diffs unless they are at least this duration in the past. Field introduced in 20.1.1. Unit is HOURS. FederatedDatastoreCleanupDuration *int64 `json:"federated_datastore_cleanup_duration,omitempty"` // Period for file object cleanup job. Field introduced in 20.1.1. Unit is MIN. FileObjectCleanupPeriod *int32 `json:"file_object_cleanup_period,omitempty"` // Number of max_dead_se_in_grp. MaxDeadSeInGrp *int32 `json:"max_dead_se_in_grp,omitempty"` // Maximum number of pcap files stored per tenant. MaxPcapPerTenant *int32 `json:"max_pcap_per_tenant,omitempty"` // Maximum delay possible to add to se_spawn_retry_interval after successive SE spawn failure. Field introduced in 20.1.1. Unit is SEC. MaxSeSpawnIntervalDelay *int32 `json:"max_se_spawn_interval_delay,omitempty"` // Maximum number of consecutive attach IP failures that halts VS placement. Field introduced in 17.2.2. MaxSeqAttachIPFailures *int32 `json:"max_seq_attach_ip_failures,omitempty"` // Number of max_seq_vnic_failures. MaxSeqVnicFailures *int32 `json:"max_seq_vnic_failures,omitempty"` // Maximum number of threads in threadpool used by cloud connector CCVIPBGWorker. Allowed values are 1-100. Field introduced in 20.1.3. MaxThreadsCcVipBgWorker *int32 `json:"max_threads_cc_vip_bg_worker,omitempty"` PermissionScopedSharedAdminNetworks *bool `json:"permission_scoped_shared_admin_networks,omitempty"` // Period for rotate app persistence keys job. Allowed values are 1-1051200. Special values are 0 - 'Disabled'. Unit is MIN. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. PersistenceKeyRotatePeriod *int32 `json:"persistence_key_rotate_period,omitempty"` // Burst limit on number of incoming requests 0 to disable. Field introduced in 20.1.1. PortalRequestBurstLimit *int32 `json:"portal_request_burst_limit,omitempty"` // Maximum average number of requests allowed per second 0 to disable. Field introduced in 20.1.1. Unit is PER_SECOND. PortalRequestRateLimit *int32 `json:"portal_request_rate_limit,omitempty"` // Token used for uploading tech-support to portal. Field introduced in 16.4.6,17.1.2. PortalToken *string `json:"portal_token,omitempty"` // Period for process locked user accounts job. Field introduced in 18.1.1. Unit is MIN. ProcessLockedUseraccountsTimeoutPeriod *int32 `json:"process_locked_useraccounts_timeout_period,omitempty"` // Period for process PKI profile job. Field introduced in 18.1.1. Unit is MIN. ProcessPkiProfileTimeoutPeriod *int32 `json:"process_pki_profile_timeout_period,omitempty"` // Unit is SEC. QueryHostFail *int32 `json:"query_host_fail,omitempty"` // Version of the safenet package installed on the controller. Field introduced in 16.5.2,17.2.3. SafenetHsmVersion *string `json:"safenet_hsm_version,omitempty"` // Unit is SEC. SeCreateTimeout *int32 `json:"se_create_timeout,omitempty"` // Interval between attempting failovers to an SE. Unit is SEC. SeFailoverAttemptInterval *int32 `json:"se_failover_attempt_interval,omitempty"` // This setting decides whether SE is to be deployed from the cloud marketplace or to be created by the controller. The setting is applicable only when BYOL license is selected. Enum options - MARKETPLACE, IMAGE. Field introduced in 18.1.4, 18.2.1. SeFromMarketplace *string `json:"se_from_marketplace,omitempty"` // Unit is SEC. SeOfflineDel *int32 `json:"se_offline_del,omitempty"` // Default retry period before attempting another Service Engine spawn in SE Group. Field introduced in 20.1.1. Unit is SEC. SeSpawnRetryInterval *int32 `json:"se_spawn_retry_interval,omitempty"` // Unit is SEC. SeVnicCooldown *int32 `json:"se_vnic_cooldown,omitempty"` // Duration to wait after last vNIC addition before proceeding with vNIC garbage collection. Used for testing purposes. Field introduced in 20.1.4. Unit is SEC. SeVnicGcWaitTime *int32 `json:"se_vnic_gc_wait_time,omitempty"` // Period for secure channel cleanup job. Unit is MIN. SecureChannelCleanupTimeout *int32 `json:"secure_channel_cleanup_timeout,omitempty"` // Unit is MIN. SecureChannelControllerTokenTimeout *int32 `json:"secure_channel_controller_token_timeout,omitempty"` // Unit is MIN. SecureChannelSeTokenTimeout *int32 `json:"secure_channel_se_token_timeout,omitempty"` // This parameter defines the number of simultaneous SE image downloads in a SeGroup. It is used to pace the SE downloads so that controller network/CPU bandwidth is a bounded operation. A value of 0 will disable the pacing scheme and all the SE(s) in the SeGroup will attempt to download the image. . Field introduced in 18.2.6. SeupgradeCopyPoolSize *int32 `json:"seupgrade_copy_pool_size,omitempty"` // Pool size used for all fabric commands during se upgrade. SeupgradeFabricPoolSize *int32 `json:"seupgrade_fabric_pool_size,omitempty"` // Time to wait before marking segroup upgrade as stuck. Unit is SEC. SeupgradeSegroupMinDeadTimeout *int32 `json:"seupgrade_segroup_min_dead_timeout,omitempty"` SharedSslCertificates *bool `json:"shared_ssl_certificates,omitempty"` // Number of days for SSL Certificate expiry warning. Unit is DAYS. SslCertificateExpiryWarningDays []int64 `json:"ssl_certificate_expiry_warning_days,omitempty,omitempty"` // Unit is SEC. UnresponsiveSeReboot *int32 `json:"unresponsive_se_reboot,omitempty"` // Time to account for DNS TTL during upgrade. This is in addition to vs_scalein_timeout_for_upgrade in se_group. Field introduced in 17.1.1. Unit is SEC. Allowed in Basic(Allowed values- 5) edition, Essentials(Allowed values- 5) edition, Enterprise edition. UpgradeDNSTTL *int32 `json:"upgrade_dns_ttl,omitempty"` // Amount of time Controller waits for a large-sized SE (>=128GB memory) to reconnect after it is rebooted during upgrade. Field introduced in 18.2.10, 20.1.1. Unit is SEC. UpgradeFatSeLeaseTime *int32 `json:"upgrade_fat_se_lease_time,omitempty"` // Amount of time Controller waits for a regular-sized SE (<128GB memory) to reconnect after it is rebooted during upgrade. Starting 18.2.10/20.1.1, the default time has increased from 360 seconds to 600 seconds. Unit is SEC. UpgradeLeaseTime *int32 `json:"upgrade_lease_time,omitempty"` // This parameter defines the upper-bound value of the VS scale-in or VS scale-out operation executed in the SeScaleIn and SeScale context. User can tweak this parameter to a higher value if the Segroup gets suspended due to SeScalein or SeScaleOut timeout failure typically associated with high number of VS(es) scaled out. . Field introduced in 18.2.10, 20.1.1. Unit is SEC. UpgradeSePerVsScaleOpsTxnTime *int32 `json:"upgrade_se_per_vs_scale_ops_txn_time,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Unit is SEC. VnicOpFailTime *int32 `json:"vnic_op_fail_time,omitempty"` // Time to wait for the scaled out SE to become ready before marking the scaleout done, applies to APIC configuration only. Unit is SEC. VsApicScaleoutTimeout *int32 `json:"vs_apic_scaleout_timeout,omitempty"` // Unit is SEC. VsAwaitingSeTimeout *int32 `json:"vs_awaiting_se_timeout,omitempty"` // Period for rotate VS keys job. Allowed values are 1-1051200. Special values are 0 - 'Disabled'. Unit is MIN. VsKeyRotatePeriod *int32 `json:"vs_key_rotate_period,omitempty"` // Interval for checking scaleout_ready status while controller is waiting for ScaleOutReady RPC from the Service Engine. Field introduced in 18.2.2. Unit is SEC. VsScaleoutReadyCheckInterval *int32 `json:"vs_scaleout_ready_check_interval,omitempty"` // Time to wait before marking attach IP operation on an SE as failed. Field introduced in 17.2.2. Unit is SEC. VsSeAttachIPFail *int32 `json:"vs_se_attach_ip_fail,omitempty"` // Unit is SEC. VsSeBootupFail *int32 `json:"vs_se_bootup_fail,omitempty"` // Unit is SEC. VsSeCreateFail *int32 `json:"vs_se_create_fail,omitempty"` // Unit is SEC. VsSePingFail *int32 `json:"vs_se_ping_fail,omitempty"` // Unit is SEC. VsSeVnicFail *int32 `json:"vs_se_vnic_fail,omitempty"` // Unit is SEC. VsSeVnicIPFail *int32 `json:"vs_se_vnic_ip_fail,omitempty"` // Unit is SEC. WarmstartSeReconnectWaitTime *int32 `json:"warmstart_se_reconnect_wait_time,omitempty"` // Timeout for warmstart VS resync. Field introduced in 18.1.4, 18.2.1. Unit is SEC. WarmstartVsResyncWaitTime *int32 `json:"warmstart_vs_resync_wait_time,omitempty"` }
ControllerProperties controller properties swagger:model ControllerProperties
type ControllerPropertiesAPIResponse ¶
type ControllerPropertiesAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ControllerProperties `json:"results,omitempty"` }
ControllerPropertiesAPIResponse controller properties Api response swagger:model ControllerPropertiesApiResponse
type ControllerSite ¶
type ControllerSite struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // IP Address or a DNS resolvable, fully qualified domain name of the Site Controller Cluster. Field introduced in 18.2.5. // Required: true Address *string `json:"address"` // Name for the Site Controller Cluster. Field introduced in 18.2.5. // Required: true Name *string `json:"name"` // The Controller Site Cluster's REST API port number. Allowed values are 1-65535. Field introduced in 18.2.5. Port *int32 `json:"port,omitempty"` // Reference for the Tenant. It is a reference to an object of type Tenant. Field introduced in 18.2.5. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Reference for the Site Controller Cluster. Field introduced in 18.2.5. UUID *string `json:"uuid,omitempty"` }
ControllerSite controller site swagger:model ControllerSite
type ControllerSiteAPIResponse ¶
type ControllerSiteAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ControllerSite `json:"results,omitempty"` }
ControllerSiteAPIResponse controller site Api response swagger:model ControllerSiteApiResponse
type ControllerSize ¶
type ControllerSize struct { // Controller flavor (S/M/L) for this controller size. Enum options - CONTROLLER_SMALL, CONTROLLER_MEDIUM, CONTROLLER_LARGE. Field introduced in 20.1.1. Flavor *string `json:"flavor,omitempty"` // Minimum number of cpu cores required. Field introduced in 20.1.1. MinCpus *int32 `json:"min_cpus,omitempty"` // Minimum memory required. Field introduced in 20.1.1. Unit is GB. MinMemory *int32 `json:"min_memory,omitempty"` }
ControllerSize controller size swagger:model ControllerSize
type ControllerSizingCloudLimits ¶
type ControllerSizingCloudLimits struct { // Maximum number of clouds of a given type. Field introduced in 20.1.1. NumClouds *int32 `json:"num_clouds,omitempty"` // Cloud type for the limit. Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Field introduced in 20.1.1. Type *string `json:"type,omitempty"` }
ControllerSizingCloudLimits controller sizing cloud limits swagger:model ControllerSizingCloudLimits
type ControllerSizingLimits ¶
type ControllerSizingLimits struct { // Controller system limits specific to cloud type for this controller sizing. Field introduced in 20.1.1. ControllerSizingCloudLimits []*ControllerSizingCloudLimits `json:"controller_sizing_cloud_limits,omitempty"` // Controller flavor (S/M/L) for this sizing limit. Enum options - CONTROLLER_SMALL, CONTROLLER_MEDIUM, CONTROLLER_LARGE. Field introduced in 20.1.1. Flavor *string `json:"flavor,omitempty"` // Maximum number of clouds. Field introduced in 20.1.1. NumClouds *int32 `json:"num_clouds,omitempty"` // Maximum number of east-west virtualservices. Field introduced in 20.1.1. NumEastWestVirtualservices *int32 `json:"num_east_west_virtualservices,omitempty"` // Maximum number of servers. Field introduced in 20.1.1. NumServers *int32 `json:"num_servers,omitempty"` // Maximum number of serviceengines. Field introduced in 20.1.1. NumServiceengines *int32 `json:"num_serviceengines,omitempty"` // Maximum number of tenants. Field introduced in 20.1.1. NumTenants *int32 `json:"num_tenants,omitempty"` // Maximum number of virtualservices. Field introduced in 20.1.1. NumVirtualservices *int32 `json:"num_virtualservices,omitempty"` // Maximum number of virtualservices with realtime metrics enabled. Field introduced in 20.1.1. NumVirtualservicesRtMetrics *int32 `json:"num_virtualservices_rt_metrics,omitempty"` // Maximum number of vrfcontexts. Field introduced in 20.1.1. NumVrfs *int32 `json:"num_vrfs,omitempty"` }
ControllerSizingLimits controller sizing limits swagger:model ControllerSizingLimits
type ControllerUpgradeState ¶
type ControllerUpgradeState struct { // Number of controller_progress. ControllerProgress *int32 `json:"controller_progress,omitempty"` // Placeholder for description of property in_progress of obj type ControllerUpgradeState field type str type boolean // Required: true InProgress *bool `json:"in_progress"` // notes of ControllerUpgradeState. Notes []string `json:"notes,omitempty"` // Placeholder for description of property rollback of obj type ControllerUpgradeState field type str type boolean Rollback *bool `json:"rollback,omitempty"` // Enum options - UPGRADE_STARTED, UPGRADE_WAITING, UPGRADE_IN_PROGRESS, UPGRADE_CONTROLLER_COMPLETED, UPGRADE_COMPLETED, UPGRADE_ABORT_IN_PROGRESS, UPGRADE_ABORTED, UPGRADE_DUMMY_1, UPGRADE_DUMMY_2, UPGRADE_DUMMY_3, UPGRADE_DUMMY_4, UPGRADE_DUMMY_5. // Required: true State *string `json:"state"` // Placeholder for description of property tasks_completed of obj type ControllerUpgradeState field type str type object TasksCompleted []*UpgradeTask `json:"tasks_completed,omitempty"` }
ControllerUpgradeState controller upgrade state swagger:model ControllerUpgradeState
type CookieMatch ¶
type CookieMatch struct { // Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. MatchCase *string `json:"match_case,omitempty"` // Criterion to use for matching the cookie in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL. // Required: true MatchCriteria *string `json:"match_criteria"` // Name of the cookie. // Required: true Name *string `json:"name"` // String value in the cookie. Value *string `json:"value,omitempty"` }
CookieMatch cookie match swagger:model CookieMatch
type CustomIPAMDNSProfile ¶
type CustomIPAMDNSProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of the Custom IPAM DNS Profile. Field introduced in 17.1.1. // Required: true Name *string `json:"name"` // Parameters that are always passed to the IPAM/DNS script. Field introduced in 17.1.1. ScriptParams []*CustomParams `json:"script_params,omitempty"` // Script URI of form controller //ipamdnsscripts/<file-name>. Field introduced in 17.1.1. // Required: true ScriptURI *string `json:"script_uri"` // It is a reference to an object of type Tenant. Field introduced in 17.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 17.1.1. UUID *string `json:"uuid,omitempty"` }
CustomIPAMDNSProfile custom ipam Dns profile swagger:model CustomIpamDnsProfile
type CustomIPAMDNSProfileAPIResponse ¶
type CustomIPAMDNSProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*CustomIPAMDNSProfile `json:"results,omitempty"` }
CustomIPAMDNSProfileAPIResponse custom ipam Dns profile Api response swagger:model CustomIpamDnsProfileApiResponse
type CustomParams ¶
type CustomParams struct { // Placeholder for description of property is_dynamic of obj type CustomParams field type str type boolean IsDynamic *bool `json:"is_dynamic,omitempty"` // Placeholder for description of property is_sensitive of obj type CustomParams field type str type boolean IsSensitive *bool `json:"is_sensitive,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // value of CustomParams. Value *string `json:"value,omitempty"` }
CustomParams custom params swagger:model CustomParams
type CustomTag ¶
type CustomTag struct { // tag_key of CustomTag. // Required: true TagKey *string `json:"tag_key"` // tag_val of CustomTag. TagVal *string `json:"tag_val,omitempty"` }
CustomTag custom tag swagger:model CustomTag
type DNSAAAARdata ¶
type DNSAAAARdata struct { // IPv6 address for FQDN. Field introduced in 18.1.1. // Required: true Ip6Address *IPAddr `json:"ip6_address"` }
DNSAAAARdata Dns a a a a rdata swagger:model DnsAAAARdata
type DNSARdata ¶
type DNSARdata struct { // IP address for FQDN. // Required: true IPAddress *IPAddr `json:"ip_address"` }
DNSARdata Dns a rdata swagger:model DnsARdata
type DNSAttack ¶
type DNSAttack struct { // The DNS attack vector. Enum options - DNS_REFLECTION, DNS_NXDOMAIN, DNS_AMPLIFICATION_EGRESS. Field introduced in 18.2.1. // Required: true AttackVector *string `json:"attack_vector"` // Enable or disable the mitigation of the attack vector. Field introduced in 18.2.1. Enabled *bool `json:"enabled,omitempty"` // Time in minutes after which mitigation will be deactivated. Allowed values are 1-4294967295. Special values are 0- 'blocked for ever'. Field introduced in 18.2.1. Unit is MIN. MaxMitigationAge *int32 `json:"max_mitigation_age,omitempty"` // Mitigation action to perform for this DNS attack vector. Field introduced in 18.2.1. MitigationAction *AttackMitigationAction `json:"mitigation_action,omitempty"` // Threshold, in terms of DNS packet per second, for the DNS attack vector. Field introduced in 18.2.3. Threshold *int64 `json:"threshold,omitempty"` }
DNSAttack Dns attack swagger:model DnsAttack
type DNSAttacks ¶
type DNSAttacks struct { // Mode of dealing with the attacks - perform detection only, or detect and mitigate the attacks. Field introduced in 18.2.1. Attacks []*DNSAttack `json:"attacks,omitempty"` // Mode of dealing with the attacks - perform detection only, or detect and mitigate the attacks. Enum options - DETECTION, MITIGATION. Field introduced in 18.2.1. OperMode *string `json:"oper_mode,omitempty"` }
DNSAttacks Dns attacks swagger:model DnsAttacks
type DNSClientIPMatch ¶
type DNSClientIPMatch struct { // IP addresses to match against client IP. Field introduced in 17.1.6,17.2.2. // Required: true ClientIP *IPAddrMatch `json:"client_ip"` // Use the IP address from the EDNS client subnet option, if available, as the source IP address of the client. It should be noted that the edns subnet IP may not be a /32 IP address. Field introduced in 17.1.6,17.2.2. UseEdnsClientSubnetIP *bool `json:"use_edns_client_subnet_ip,omitempty"` }
DNSClientIPMatch Dns client Ip match swagger:model DnsClientIpMatch
type DNSCnameRdata ¶
type DNSCnameRdata struct { // Canonical name. // Required: true Cname *string `json:"cname"` }
DNSCnameRdata Dns cname rdata swagger:model DnsCnameRdata
type DNSConfig ¶
type DNSConfig struct { // GSLB subdomain used for GSLB service FQDN match and placement. . // Required: true DomainName *string `json:"domain_name"` }
DNSConfig DNS config swagger:model DNSConfig
type DNSConfiguration ¶
type DNSConfiguration struct { // Search domain to use in DNS lookup. SearchDomain *string `json:"search_domain,omitempty"` // List of DNS Server IP addresses. ServerList []*IPAddr `json:"server_list,omitempty"` }
DNSConfiguration DNS configuration swagger:model DNSConfiguration
type DNSEdnsOption ¶
type DNSEdnsOption struct { // Address family. Field introduced in 17.1.1. AddrFamily *int32 `json:"addr_family,omitempty"` // EDNS option code. Enum options - EDNS_OPTION_CODE_NSID, EDNS_OPTION_CODE_DNSSEC_DAU, EDNS_OPTION_CODE_DNSSEC_DHU, EDNS_OPTION_CODE_DNSSEC_N3U, EDNS_OPTION_CODE_CLIENT_SUBNET, EDNS_OPTION_CODE_EXPIRE, EDNS_OPTION_CODE_COOKIE, EDNS_OPTION_CODE_TCP_KEEPALIVE, EDNS_OPTION_CODE_PADDING, EDNS_OPTION_CODE_CHAIN. Field introduced in 17.1.1. // Required: true Code *string `json:"code"` // Scope prefix length of address. Field introduced in 17.1.1. ScopePrefixLen *int32 `json:"scope_prefix_len,omitempty"` // Source prefix length of address. Field introduced in 17.1.1. SourcePrefixLen *int32 `json:"source_prefix_len,omitempty"` // IPv4 address of the client subnet. Field introduced in 17.1.1. SubnetIP *int32 `json:"subnet_ip,omitempty"` // IPv6 address of the client subnet. Field introduced in 18.2.12, 20.1.3. SubnetIp6 *string `json:"subnet_ip6,omitempty"` }
DNSEdnsOption Dns edns option swagger:model DnsEdnsOption
type DNSGeoLocationMatch ¶
type DNSGeoLocationMatch struct { // Geographical location of the client IP to be used in the match. This location is of the format Country/State/City e.g. US/CA/Santa Clara. Field introduced in 17.1.5. GeolocationName *string `json:"geolocation_name,omitempty"` // Geolocation tag for the client IP. This could be any *string value for the client IP, e.g. client IPs from US East Coast geolocation would be tagged as 'East Coast'. Field introduced in 17.1.5. GeolocationTag *string `json:"geolocation_tag,omitempty"` // Criterion to use for matching the client IP's geographical location. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.1.5. // Required: true MatchCriteria *string `json:"match_criteria"` // Use the IP address from the EDNS client subnet option, if available, to derive geo location of the DNS query. Field introduced in 17.1.5. UseEdnsClientSubnetIP *bool `json:"use_edns_client_subnet_ip,omitempty"` }
DNSGeoLocationMatch Dns geo location match swagger:model DnsGeoLocationMatch
type DNSInfo ¶
type DNSInfo struct { // Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is consistent hash. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 17.1.1. Algorithm *string `json:"algorithm,omitempty"` // Canonical name in CNAME record. Field introduced in 17.2.1. Cname *DNSCnameRdata `json:"cname,omitempty"` // Fully qualified domain name. Fqdn *string `json:"fqdn,omitempty"` // Any metadata associated with this record. Field introduced in 17.2.2. // Read Only: true Metadata *string `json:"metadata,omitempty"` // Specifies the number of records returned for this FQDN. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- 'Return all records'. Field introduced in 17.1.1. NumRecordsInResponse *int32 `json:"num_records_in_response,omitempty"` // Time to live for fqdn record. Default value is chosen from DNS profile for this cloud if no value provided. TTL *int32 `json:"ttl,omitempty"` // DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Type *string `json:"type,omitempty"` }
DNSInfo Dns info swagger:model DnsInfo
type DNSMxRdata ¶
type DNSMxRdata struct { // Fully qualified domain name of a mailserver . The host name maps directly to one or more address records in the DNS table, and must not point to any CNAME records (RFC 2181). Field introduced in 18.2.9, 20.1.1. // Required: true Host *string `json:"host"` // The priority field identifies which mail server should be preferred. Allowed values are 0-65535. Field introduced in 18.2.9, 20.1.1. // Required: true Priority *int32 `json:"priority"` }
DNSMxRdata Dns mx rdata swagger:model DnsMxRdata
type DNSNsRdata ¶
type DNSNsRdata struct { // IPv6 address for Name Server. Field introduced in 18.1.1. Ip6Address *IPAddr `json:"ip6_address,omitempty"` // IP address for Name Server. Field introduced in 17.1.1. IPAddress *IPAddr `json:"ip_address,omitempty"` // Name Server name. Field introduced in 17.1.1. // Required: true Nsname *string `json:"nsname"` }
DNSNsRdata Dns ns rdata swagger:model DnsNsRdata
type DNSOptRecord ¶
type DNSOptRecord struct { // Flag indicating client is DNSSEC aware. Field introduced in 17.1.1. DnssecOk *bool `json:"dnssec_ok,omitempty"` // EDNS options. Field introduced in 17.1.1. Options []*DNSEdnsOption `json:"options,omitempty"` // Client requestor's UDP payload size. Field introduced in 17.1.1. UDPPayloadSize *int32 `json:"udp_payload_size,omitempty"` // EDNS version. Field introduced in 17.1.1. Version *int32 `json:"version,omitempty"` }
DNSOptRecord Dns opt record swagger:model DnsOptRecord
type DNSPolicies ¶
type DNSPolicies struct { // UUID of the dns policy. It is a reference to an object of type DnsPolicy. Field introduced in 17.1.1. // Required: true DNSPolicyRef *string `json:"dns_policy_ref"` // Index of the dns policy. Field introduced in 17.1.1. // Required: true Index *int32 `json:"index"` }
DNSPolicies Dns policies swagger:model DnsPolicies
type DNSPolicy ¶
type DNSPolicy struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Creator name. Field introduced in 17.1.1. CreatedBy *string `json:"created_by,omitempty"` // Field introduced in 17.1.1. Description *string `json:"description,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the DNS Policy. Field introduced in 17.1.1. // Required: true Name *string `json:"name"` // DNS rules. Field introduced in 17.1.1. Rule []*DNSRule `json:"rule,omitempty"` // It is a reference to an object of type Tenant. Field introduced in 17.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the DNS Policy. Field introduced in 17.1.1. UUID *string `json:"uuid,omitempty"` }
DNSPolicy Dns policy swagger:model DnsPolicy
type DNSPolicyAPIResponse ¶
type DNSPolicyAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*DNSPolicy `json:"results,omitempty"` }
DNSPolicyAPIResponse Dns policy Api response swagger:model DnsPolicyApiResponse
type DNSQueryNameMatch ¶
type DNSQueryNameMatch struct { // Criterion to use for *string matching the DNS query domain name in the question section. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Field introduced in 17.1.1. Allowed in Basic(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Essentials(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Enterprise edition. // Required: true MatchCriteria *string `json:"match_criteria"` // Domain name to match against that specified in the question section of the DNS query. Field introduced in 17.1.1. QueryDomainNames []string `json:"query_domain_names,omitempty"` // UUID of the *string group(s) for matching against DNS query domain name in the question section. It is a reference to an object of type StringGroup. Field introduced in 17.1.1. StringGroupRefs []string `json:"string_group_refs,omitempty"` }
DNSQueryNameMatch Dns query name match swagger:model DnsQueryNameMatch
type DNSQueryTypeMatch ¶
type DNSQueryTypeMatch struct { // Criterion to use for matching the DNS query typein the question section. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.1.1. // Required: true MatchCriteria *string `json:"match_criteria"` // DNS query types in the request query . Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Field introduced in 17.1.1. QueryType []string `json:"query_type,omitempty"` }
DNSQueryTypeMatch Dns query type match swagger:model DnsQueryTypeMatch
type DNSRateLimiter ¶
type DNSRateLimiter struct { // Action to perform upon rate limiting. Field introduced in 20.1.1. // Required: true Action *DNSRuleRLAction `json:"action"` // Rate limiting object. Field introduced in 20.1.1. // Required: true RateLimiterObject *RateLimiter `json:"rate_limiter_object"` }
DNSRateLimiter Dns rate limiter swagger:model DnsRateLimiter
type DNSRateProfile ¶
type DNSRateProfile struct { // Action to perform upon rate limiting. Field deprecated in 20.1.1. Field introduced in 18.2.5. // Required: true Action *DNSRuleRLAction `json:"action"` // Maximum number of connections or requests or packets to be rate limited instantaneously. Field deprecated in 20.1.1. Field introduced in 18.2.5. BurstSize *int32 `json:"burst_size,omitempty"` // Maximum number of connections or requests or packets per second. It is deprecated because of adoption of new shared rate limiter protobuf. Allowed values are 1-4294967295. Special values are 0- 'unlimited'. Field deprecated in 20.1.1. Field introduced in 18.2.5. Count *int32 `json:"count,omitempty"` // Enable fine granularity. Field deprecated in 20.1.1. Field introduced in 18.2.5. FineGrain *bool `json:"fine_grain,omitempty"` // Time value in seconds to enforce rate count. Allowed values are 1-300. Field deprecated in 20.1.1. Field introduced in 18.2.5. Unit is SEC. Period *int32 `json:"period,omitempty"` }
DNSRateProfile Dns rate profile swagger:model DnsRateProfile
type DNSRecord ¶
type DNSRecord struct { // Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is round-robin. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 17.1.1. Algorithm *string `json:"algorithm,omitempty"` // Canonical name in CNAME record. Cname *DNSCnameRdata `json:"cname,omitempty"` // Configured FQDNs are delegated domains (i.e. they represent a zone cut). Field introduced in 17.1.2. Delegated *bool `json:"delegated,omitempty"` // Details of DNS record. Description *string `json:"description,omitempty"` // Fully Qualified Domain Name. Minimum of 1 items required. Fqdn []string `json:"fqdn,omitempty"` // IPv6 address in AAAA record. Field introduced in 18.1.1. Maximum of 4 items allowed. Ip6Address []*DNSAAAARdata `json:"ip6_address,omitempty"` // IP address in A record. Maximum of 4 items allowed. IPAddress []*DNSARdata `json:"ip_address,omitempty"` // Internal metadata for the DNS record. Field introduced in 18.2.5. Metadata *string `json:"metadata,omitempty"` // MX record. Field introduced in 18.2.9, 20.1.1. Maximum of 4 items allowed. MxRecords []*DNSMxRdata `json:"mx_records,omitempty"` // Name Server information in NS record. Field introduced in 17.1.1. Maximum of 13 items allowed. Ns []*DNSNsRdata `json:"ns,omitempty"` // Specifies the number of records returned by the DNS service. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- 'Return all records'. Field introduced in 17.1.1. NumRecordsInResponse *int32 `json:"num_records_in_response,omitempty"` // Service locator info in SRV record. Maximum of 4 items allowed. ServiceLocator []*DNSSrvRdata `json:"service_locator,omitempty"` // Time To Live for this DNS record. TTL *int32 `json:"ttl,omitempty"` // Text record. Field introduced in 18.2.9, 20.1.1. Maximum of 4 items allowed. TxtRecords []*DNSTxtRdata `json:"txt_records,omitempty"` // DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. // Required: true Type *string `json:"type"` // Enable wild-card match of fqdn if an exact match is not found in the DNS table, the longest match is chosen by wild-carding the fqdn in the DNS request. Default is false. Field introduced in 17.1.1. WildcardMatch *bool `json:"wildcard_match,omitempty"` }
DNSRecord Dns record swagger:model DnsRecord
type DNSRegisterInfo ¶
type DNSRegisterInfo struct { // Placeholder for description of property dns_info of obj type DNSRegisterInfo field type str type object DNSInfo []*DNSInfo `json:"dns_info,omitempty"` // error of DNSRegisterInfo. Error *string `json:"error,omitempty"` // Placeholder for description of property fip of obj type DNSRegisterInfo field type str type object Fip *IPAddr `json:"fip,omitempty"` // Number of total_records. TotalRecords *int32 `json:"total_records,omitempty"` // Placeholder for description of property vip of obj type DNSRegisterInfo field type str type object Vip *IPAddr `json:"vip,omitempty"` // vip_id of DNSRegisterInfo. VipID *string `json:"vip_id,omitempty"` // vs_names of DNSRegisterInfo. VsNames []string `json:"vs_names,omitempty"` // Unique object identifiers of vss. VsUuids []string `json:"vs_uuids,omitempty"` }
DNSRegisterInfo DNS register info swagger:model DNSRegisterInfo
type DNSRequest ¶
type DNSRequest struct { // Number of additional records. Field introduced in 17.1.1. AdditionalRecordsCount *int32 `json:"additional_records_count,omitempty"` // Number of answer records in the client DNS request. Field introduced in 17.1.1. AnswerRecordsCount *int32 `json:"answer_records_count,omitempty"` // Flag indicating client understands AD bit and is interested in the value of AD bit in the response. Field introduced in 17.1.1. AuthenticData *bool `json:"authentic_data,omitempty"` // Flag indicating client does not want DNSSEC validation of the response. Field introduced in 17.1.1. CheckingDisabled *bool `json:"checking_disabled,omitempty"` // Geo Location of Client. Field introduced in 17.1.1. ClientLocation *GeoLocation `json:"client_location,omitempty"` // ID of the DNS request. Field introduced in 17.1.1. Identifier *int32 `json:"identifier,omitempty"` // Number of nameserver records in the client DNS request. Field introduced in 17.1.1. NameserverRecordsCount *int32 `json:"nameserver_records_count,omitempty"` // DNS request operation code e.g. QUERY, NOTIFY, etc. Enum options - DNS_OPCODE_QUERY, DNS_OPCODE_IQUERY, DNS_OPCODE_STATUS, DNS_OPCODE_NOTIFY, DNS_OPCODE_UPDATE. Field introduced in 17.1.1. Opcode *string `json:"opcode,omitempty"` // Opt resource records in the request. Field introduced in 17.1.1. OptRecord *DNSOptRecord `json:"opt_record,omitempty"` // Flag indicating request is a client query (false) or server response (true). Field introduced in 17.1.1. QueryOrResponse *bool `json:"query_or_response,omitempty"` // Number of questions in the client DNS request. Field introduced in 17.1.1. QuestionCount *int32 `json:"question_count,omitempty"` // Flag indicating client request for recursive resolution. Field introduced in 17.1.1. RecursionDesired *bool `json:"recursion_desired,omitempty"` }
DNSRequest Dns request swagger:model DnsRequest
type DNSResourceRecord ¶
type DNSResourceRecord struct { // IPv6 address of the requested FQDN. Field introduced in 18.1.1. Addr6IPStr *string `json:"addr6_ip_str,omitempty"` // IPv4 address of the requested FQDN. AddrIP *int32 `json:"addr_ip,omitempty"` // Canonical (real) name of the requested FQDN. Cname *string `json:"cname,omitempty"` // Class of the data in the resource record. Dclass *int32 `json:"dclass,omitempty"` // Geo Location of Member. Field introduced in 17.1.1. Location *GeoLocation `json:"location,omitempty"` // Fully qualified domain name of a mail server in the MX record. Field introduced in 18.2.9, 20.1.1. MailServer *string `json:"mail_server,omitempty"` // Domain name of the resource record. Name *string `json:"name,omitempty"` // Domain name of the name server that is authoritative for the requested FQDN. Nsname *string `json:"nsname,omitempty"` // Service port. Port *int32 `json:"port,omitempty"` // The priority field identifies which mail server should be preferred. Field introduced in 18.2.9, 20.1.1. Priority *int32 `json:"priority,omitempty"` // Site controller cluster name - applicable only for Avi VS GSLB member. SiteName *string `json:"site_name,omitempty"` // Text resource record. Field introduced in 18.2.9, 20.1.1. TextRdata *string `json:"text_rdata,omitempty"` // Number of seconds the resource record can be cached. // Required: true TTL *int32 `json:"ttl"` // Type of resource record. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. // Required: true Type *string `json:"type"` // Virtual Service name - applicable only for Avi VS GSLB member. VsName *string `json:"vs_name,omitempty"` }
DNSResourceRecord Dns resource record swagger:model DnsResourceRecord
type DNSResponse ¶
type DNSResponse struct { // Number of additional records. AdditionalRecordsCount *int32 `json:"additional_records_count,omitempty"` // Number of answer records. AnswerRecordsCount *int32 `json:"answer_records_count,omitempty"` // Flag to indicate the responding DNS is an authority for the requested FQDN. AuthoritativeAnswer *bool `json:"authoritative_answer,omitempty"` // Flag to indicate whether fallback algorithm was used to serve this request. Field introduced in 18.2.3. FallbackAlgorithmUsed *bool `json:"fallback_algorithm_used,omitempty"` // Resource records in the response are generated based on wildcard match. Field introduced in 18.2.1. IsWildcard *bool `json:"is_wildcard,omitempty"` // Number of nameserver records. NameserverRecordsCount *int32 `json:"nameserver_records_count,omitempty"` // DNS response operation code e.g. QUERY, NOTIFY, etc. Enum options - DNS_OPCODE_QUERY, DNS_OPCODE_IQUERY, DNS_OPCODE_STATUS, DNS_OPCODE_NOTIFY, DNS_OPCODE_UPDATE. Field introduced in 17.1.3. Opcode *string `json:"opcode,omitempty"` // Opt resource records in the response. Field introduced in 17.1.1. OptRecord *DNSOptRecord `json:"opt_record,omitempty"` // Flag indicating response is a client query (false) or server response (true). Field introduced in 17.1.3. QueryOrResponse *bool `json:"query_or_response,omitempty"` // Number of questions in the client DNS request eliciting this DNS response. Field introduced in 17.1.3. QuestionCount *int32 `json:"question_count,omitempty"` // Resource records in the response. Records []*DNSResourceRecord `json:"records,omitempty"` // Flag indicating the DNS query is fully answered. RecursionAvailable *bool `json:"recursion_available,omitempty"` // Flag copied from the DNS query's recursion desired field by the responding DNS. Field introduced in 17.1.3. RecursionDesired *bool `json:"recursion_desired,omitempty"` // Response code in the response. Enum options - DNS_RCODE_NOERROR, DNS_RCODE_FORMERR, DNS_RCODE_SERVFAIL, DNS_RCODE_NXDOMAIN, DNS_RCODE_NOTIMP, DNS_RCODE_REFUSED, DNS_RCODE_YXDOMAIN, DNS_RCODE_YXRRSET, DNS_RCODE_NXRRSET, DNS_RCODE_NOTAUTH, DNS_RCODE_NOTZONE. ResponseCode *string `json:"response_code,omitempty"` // Flag to indicate if the answer received from DNS is truncated (original answer exceeds 512 bytes UDP limit). Truncation *bool `json:"truncation,omitempty"` }
DNSResponse Dns response swagger:model DnsResponse
type DNSRrSet ¶
type DNSRrSet struct { // Canonical name in CNAME record. Field introduced in 17.2.12, 18.1.2. Cname *DNSCnameRdata `json:"cname,omitempty"` // Fully Qualified Domain Name. Field introduced in 17.2.12, 18.1.2. // Required: true Fqdn *string `json:"fqdn"` // IPv6 address in AAAA record. Field introduced in 18.1.2. Ip6Addresses []*DNSAAAARdata `json:"ip6_addresses,omitempty"` // IP address in A record. Field introduced in 17.2.12, 18.1.2. IPAddresses []*DNSARdata `json:"ip_addresses,omitempty"` // Name Server information in NS record. Field introduced in 17.2.12, 18.1.2. Nses []*DNSNsRdata `json:"nses,omitempty"` // Time To Live for this DNS record. Allowed values are 0-2147483647. Field introduced in 17.2.12, 18.1.2. // Required: true TTL *int32 `json:"ttl"` // DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Field introduced in 17.2.12, 18.1.2. // Required: true Type *string `json:"type"` }
DNSRrSet Dns rr set swagger:model DnsRrSet
type DNSRule ¶
type DNSRule struct { // Action to be performed upon successful matching. Field introduced in 17.1.1. Action *DNSRuleAction `json:"action,omitempty"` // Enable or disable the rule. Field introduced in 17.1.1. Enable *bool `json:"enable,omitempty"` // Index of the rule. Field introduced in 17.1.1. // Required: true Index *int32 `json:"index"` // Log DNS query upon rule match. Field introduced in 17.1.1. Log *bool `json:"log,omitempty"` // Add match criteria to the rule. Field introduced in 17.1.1. Match *DNSRuleMatchTarget `json:"match,omitempty"` // Name of the rule. Field introduced in 17.1.1. // Required: true Name *string `json:"name"` }
DNSRule Dns rule swagger:model DnsRule
type DNSRuleAction ¶
type DNSRuleAction struct { // Allow or drop the DNS query. Field introduced in 17.1.1. Allow *DNSRuleActionAllowDrop `json:"allow,omitempty"` // Rate limits the DNS requests. Field deprecated in 20.1.1. Field introduced in 18.2.5. DNSRateLimit *DNSRateProfile `json:"dns_rate_limit,omitempty"` // Rate limits the DNS requests. Field introduced in 20.1.1. DNSRateLimiter *DNSRateLimiter `json:"dns_rate_limiter,omitempty"` // Select a specific GSLB site for the DNS query. This action should be used only when GSLB services have been configured for the DNS virtual service. Field introduced in 17.1.5. GslbSiteSelection *DNSRuleActionGslbSiteSelection `json:"gslb_site_selection,omitempty"` // Select a pool or pool group for the passthrough DNS query which cannot be served locally but could be served by upstream servers. Field introduced in 18.1.3, 17.2.12. PoolSwitching *DNSRuleActionPoolSwitching `json:"pool_switching,omitempty"` // Generate a response for the DNS query. Field introduced in 17.1.1. Response *DNSRuleActionResponse `json:"response,omitempty"` }
DNSRuleAction Dns rule action swagger:model DnsRuleAction
type DNSRuleActionAllowDrop ¶
type DNSRuleActionAllowDrop struct { // Allow the DNS query. Field introduced in 17.1.1. Allow *bool `json:"allow,omitempty"` // Reset the TCP connection of the DNS query, if allow is set to false to drop the query. Field introduced in 17.1.1. ResetConn *bool `json:"reset_conn,omitempty"` }
DNSRuleActionAllowDrop Dns rule action allow drop swagger:model DnsRuleActionAllowDrop
type DNSRuleActionGslbSiteSelection ¶
type DNSRuleActionGslbSiteSelection struct { // GSLB fallback sites to use in case the desired site is down. Field introduced in 17.2.5. Maximum of 64 items allowed. FallbackSiteNames []string `json:"fallback_site_names,omitempty"` // When set to true, GSLB site is a preferred site. This setting comes into play when the site is down, as well as no configured fallback site is available (all fallback sites are also down), then any one available site is selected based on the default algorithm for GSLB pool member selection. Field introduced in 17.2.5. IsSitePreferred *bool `json:"is_site_preferred,omitempty"` // GSLB site name. Field introduced in 17.1.5. // Required: true SiteName *string `json:"site_name"` }
DNSRuleActionGslbSiteSelection Dns rule action gslb site selection swagger:model DnsRuleActionGslbSiteSelection
type DNSRuleActionPoolSwitching ¶
type DNSRuleActionPoolSwitching struct { // Reference of the pool group to serve the passthrough DNS query which cannot be served locally. It is a reference to an object of type PoolGroup. Field introduced in 18.1.3, 17.2.12. PoolGroupRef *string `json:"pool_group_ref,omitempty"` // Reference of the pool to serve the passthrough DNS query which cannot be served locally. It is a reference to an object of type Pool. Field introduced in 18.1.3, 17.2.12. PoolRef *string `json:"pool_ref,omitempty"` }
DNSRuleActionPoolSwitching Dns rule action pool switching swagger:model DnsRuleActionPoolSwitching
type DNSRuleActionResponse ¶
type DNSRuleActionResponse struct { // DNS response is authoritative. Field introduced in 17.1.1. Authoritative *bool `json:"authoritative,omitempty"` // DNS response code. Enum options - DNS_RCODE_NOERROR, DNS_RCODE_FORMERR, DNS_RCODE_SERVFAIL, DNS_RCODE_NXDOMAIN, DNS_RCODE_NOTIMP, DNS_RCODE_REFUSED, DNS_RCODE_YXDOMAIN, DNS_RCODE_YXRRSET, DNS_RCODE_NXRRSET, DNS_RCODE_NOTAUTH, DNS_RCODE_NOTZONE. Field introduced in 17.1.1. Rcode *string `json:"rcode,omitempty"` // DNS resource record sets - (resource record set share the DNS domain name, type, and class). Field introduced in 17.2.12, 18.1.2. ResourceRecordSets []*DNSRuleDNSRrSet `json:"resource_record_sets,omitempty"` // DNS response is truncated. Field introduced in 17.1.1. Truncation *bool `json:"truncation,omitempty"` }
DNSRuleActionResponse Dns rule action response swagger:model DnsRuleActionResponse
type DNSRuleDNSRrSet ¶
type DNSRuleDNSRrSet struct { // DNS resource record set - (records in the resource record set share the DNS domain name, type, and class). Field introduced in 17.2.12, 18.1.2. // Required: true ResourceRecordSet *DNSRrSet `json:"resource_record_set"` // DNS message section for the resource record set. Enum options - DNS_MESSAGE_SECTION_QUESTION, DNS_MESSAGE_SECTION_ANSWER, DNS_MESSAGE_SECTION_AUTHORITY, DNS_MESSAGE_SECTION_ADDITIONAL. Field introduced in 17.2.12, 18.1.2. Section *string `json:"section,omitempty"` }
DNSRuleDNSRrSet Dns rule Dns rr set swagger:model DnsRuleDnsRrSet
type DNSRuleMatchTarget ¶
type DNSRuleMatchTarget struct { // IP addresses to match against client IP. From 17.1.6 release onwards, IP addresses needs to be configured in the client_ip_address field of this message. Field deprecated in 17.1.6,17.2.2. Field introduced in 17.1.1. ClientIP *IPAddrMatch `json:"client_ip,omitempty"` // IP addresses to match against client IP or the EDNS client subnet IP. Field introduced in 17.1.6,17.2.2. ClientIPAddress *DNSClientIPMatch `json:"client_ip_address,omitempty"` // Geographical location attribute to match against that of the client IP. Field introduced in 17.1.5. GeoLocation *DNSGeoLocationMatch `json:"geo_location,omitempty"` // DNS transport protocol match. Field introduced in 17.1.1. Protocol *DNSTransportProtocolMatch `json:"protocol,omitempty"` // Domain names to match against query name. Field introduced in 17.1.1. QueryName *DNSQueryNameMatch `json:"query_name,omitempty"` // DNS query types to match against request query type. Field introduced in 17.1.1. QueryType *DNSQueryTypeMatch `json:"query_type,omitempty"` }
DNSRuleMatchTarget Dns rule match target swagger:model DnsRuleMatchTarget
type DNSRuleRLAction ¶
type DNSRuleRLAction struct { // Type of action to be enforced upon hitting the rate limit. Enum options - DNS_RL_ACTION_NONE, DNS_RL_ACTION_DROP_REQ. Field introduced in 18.2.5. Type *string `json:"type,omitempty"` }
DNSRuleRLAction Dns rule r l action swagger:model DnsRuleRLAction
type DNSServiceApplicationProfile ¶
type DNSServiceApplicationProfile struct { // Respond to AAAA queries with empty response when there are only IPV4 records. AaaaEmptyResponse *bool `json:"aaaa_empty_response,omitempty"` // Email address of the administrator responsible for this zone . This field is used in SOA records (rname) pertaining to all domain names specified as authoritative domain names. If not configured, the default value 'hostmaster' is used in SOA responses. Field introduced in 18.2.5. AdminEmail *string `json:"admin_email,omitempty"` // Domain names authoritatively serviced by this Virtual Service. These are configured as Ends-With semantics. Queries for FQDNs that are subdomains of this domain and do not have any DNS record in Avi are dropped or NXDomain response sent. . Field deprecated in 18.2.6. Field introduced in 17.1.6,17.2.2. Maximum of 100 items allowed. AuthoritativeDomainNames []string `json:"authoritative_domain_names,omitempty"` // Enable DNS query/response over TCP. This enables analytics for pass-through queries as well. Field introduced in 17.1.1. DNSOverTCPEnabled *bool `json:"dns_over_tcp_enabled,omitempty"` // DNS zones hosted on this Virtual Service. Field introduced in 18.2.6. Maximum of 100 items allowed. DNSZones []*DNSZone `json:"dns_zones,omitempty"` // Subdomain names serviced by this Virtual Service. These are configured as Ends-With semantics. Maximum of 100 items allowed. DomainNames []string `json:"domain_names,omitempty"` // Enable stripping of EDNS client subnet (ecs) option towards client if DNS service inserts ecs option in the DNS query towards upstream servers. Field introduced in 17.1.5. EcsStrippingEnabled *bool `json:"ecs_stripping_enabled,omitempty"` // Enable DNS service to be aware of EDNS (Extension mechanism for DNS). EDNS extensions are parsed and shown in logs. For GSLB services, the EDNS client subnet option can be used to influence Load Balancing. Field introduced in 17.1.1. Edns *bool `json:"edns,omitempty"` // Specifies the IP address prefix length to use in the EDNS client subnet (ECS) option. When the incoming request does not have any ECS option and the prefix length is specified, an ECS option is inserted in the request passed to upstream server. If the incoming request already has an ECS option, the prefix length (and correspondingly the address) in the ECS option is updated, with the minimum of the prefix length present in the incoming and the configured prefix length, before passing the request to upstream server. Allowed values are 1-32. Field introduced in 17.1.3. EdnsClientSubnetPrefixLen *int32 `json:"edns_client_subnet_prefix_len,omitempty"` // Drop or respond to client when the DNS service encounters an error processing a client query. By default, such a request is dropped without any response, or passed through to a passthrough pool, if configured. When set to respond, an appropriate response is sent to client, e.g. NXDOMAIN response for non-existent records, empty NOERROR response for unsupported queries, etc. Enum options - DNS_ERROR_RESPONSE_ERROR, DNS_ERROR_RESPONSE_NONE. ErrorResponse *string `json:"error_response,omitempty"` // The <domain-name> of the name server that was the original or primary source of data for this zone. This field is used in SOA records (mname) pertaining to all domain names specified as authoritative domain names. If not configured, domain name is used as name server in SOA response. Field introduced in 18.2.5. NameServer *string `json:"name_server,omitempty"` // Specifies the TTL value (in seconds) for SOA (Start of Authority) (corresponding to a authoritative domain owned by this DNS Virtual Service) record's minimum TTL served by the DNS Virtual Service. Allowed values are 0-86400. Field introduced in 17.2.4. Unit is SEC. NegativeCachingTTL *int32 `json:"negative_caching_ttl,omitempty"` // Specifies the number of IP addresses returned by the DNS Service. Enter 0 to return all IP addresses. Allowed values are 1-20. Special values are 0- 'Return all IP addresses'. NumDNSIP *int32 `json:"num_dns_ip,omitempty"` // Specifies the TTL value (in seconds) for records served by DNS Service. Allowed values are 0-86400. Unit is SEC. TTL *int32 `json:"ttl,omitempty"` }
DNSServiceApplicationProfile Dns service application profile swagger:model DnsServiceApplicationProfile
type DNSServiceDomain ¶
type DNSServiceDomain struct { // Service domain *string used for FQDN. // Required: true DomainName *string `json:"domain_name"` // Specifies the number of A records returned by Avi DNS Service. Allowed values are 0-20. Special values are 0- 'Return all IP addresses'. NumDNSIP *int32 `json:"num_dns_ip,omitempty"` // Third-party Authoritative domain requests are delegated toDNS VirtualService's pool of nameservers. PassThrough *bool `json:"pass_through,omitempty"` // TTL value for DNS records. Allowed values are 1-604800. Unit is SEC. RecordTTL *int32 `json:"record_ttl,omitempty"` }
DNSServiceDomain Dns service domain swagger:model DnsServiceDomain
type DNSSrvRdata ¶
type DNSSrvRdata struct { // Service port. Allowed values are 0-65535. // Required: true Port *int32 `json:"port"` // Priority of the target hosting the service, low value implies higher priority for this service record. Allowed values are 0-65535. Priority *int32 `json:"priority,omitempty"` // Canonical hostname, of the machine hosting the service, with no trailing period. 'default.host' is valid but not 'default.host.'. Target *string `json:"target,omitempty"` // Relative weight for service records with same priority, high value implies higher preference for this service record. Allowed values are 0-65535. Weight *int32 `json:"weight,omitempty"` }
DNSSrvRdata Dns srv rdata swagger:model DnsSrvRdata
type DNSTransportProtocolMatch ¶
type DNSTransportProtocolMatch struct { // Criterion to use for matching the DNS transport protocol. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.1.1. // Required: true MatchCriteria *string `json:"match_criteria"` // Protocol to match against transport protocol used by DNS query. Enum options - DNS_OVER_UDP, DNS_OVER_TCP. Field introduced in 17.1.1. // Required: true Protocol *string `json:"protocol"` }
DNSTransportProtocolMatch Dns transport protocol match swagger:model DnsTransportProtocolMatch
type DNSTxtRdata ¶
type DNSTxtRdata struct { // Text data associated with the FQDN. Field introduced in 18.2.9, 20.1.1. // Required: true TextStr *string `json:"text_str"` }
DNSTxtRdata Dns txt rdata swagger:model DnsTxtRdata
type DNSVsSyncInfo ¶
type DNSVsSyncInfo struct { // error of DNSVsSyncInfo. Error *string `json:"error,omitempty"` // Number of total_records. TotalRecords *int32 `json:"total_records,omitempty"` }
DNSVsSyncInfo DNS vs sync info swagger:model DNSVsSyncInfo
type DNSZone ¶
type DNSZone struct { // Email address of the administrator responsible for this zone. This field is used in SOA records as rname (RFC 1035). If not configured, it is inherited from the DNS service profile. Field introduced in 18.2.6. AdminEmail *string `json:"admin_email,omitempty"` // Domain name authoritatively serviced by this Virtual Service. Queries for FQDNs that are sub domains of this domain and do not have any DNS record in Avi are dropped or NXDomain response sent. For domains which are present, SOA parameters are sent in answer section of response if query type is SOA. Field introduced in 18.2.6. // Required: true DomainName *string `json:"domain_name"` // The primary name server for this zone. This field is used in SOA records as mname (RFC 1035). If not configured, it is inherited from the DNS service profile. If even that is not configured, the domain name is used instead. Field introduced in 18.2.6. NameServer *string `json:"name_server,omitempty"` }
DNSZone Dns zone swagger:model DnsZone
type DSRequestLog ¶
type DSRequestLog struct { // Name of the DataScript where this request was called. Field introduced in 20.1.3. DsName *string `json:"ds_name,omitempty"` // DataScript event where out-of-band request was sent. Enum options - VS_DATASCRIPT_EVT_HTTP_REQ, VS_DATASCRIPT_EVT_HTTP_RESP, VS_DATASCRIPT_EVT_HTTP_RESP_DATA, VS_DATASCRIPT_EVT_HTTP_LB_FAILED, VS_DATASCRIPT_EVT_HTTP_REQ_DATA, VS_DATASCRIPT_EVT_HTTP_RESP_FAILED, VS_DATASCRIPT_EVT_HTTP_LB_DONE, VS_DATASCRIPT_EVT_HTTP_AUTH, VS_DATASCRIPT_EVT_HTTP_POST_AUTH, VS_DATASCRIPT_EVT_TCP_CLIENT_ACCEPT, VS_DATASCRIPT_EVT_SSL_HANDSHAKE_DONE, VS_DATASCRIPT_EVT_DNS_REQ, VS_DATASCRIPT_EVT_DNS_RESP, VS_DATASCRIPT_EVT_L4_REQUEST, VS_DATASCRIPT_EVT_L4_RESPONSE, VS_DATASCRIPT_EVT_MAX. Field introduced in 20.1.3. Event *string `json:"event,omitempty"` // Response headers received from the server. Field introduced in 20.1.3. HeadersReceivedFromServer *string `json:"headers_received_from_server,omitempty"` // Request headers sent to the server. Field introduced in 20.1.3. HeadersSentToServer *string `json:"headers_sent_to_server,omitempty"` // The HTTP response code received from the external server. Field introduced in 20.1.3. HTTPResponseCode *int32 `json:"http_response_code,omitempty"` // The HTTP version of the out-of-band request. Field introduced in 20.1.3. HTTPVersion *string `json:"http_version,omitempty"` // The HTTP method of the out-of-band request. Field introduced in 20.1.3. Method *string `json:"method,omitempty"` // The name of the pool that was used for the request. Field introduced in 20.1.3. PoolName *string `json:"pool_name,omitempty"` // The uuid of the pool that was used for the request. Field introduced in 20.1.3. PoolUUID *string `json:"pool_uuid,omitempty"` // Length of the request sent in bytes. Field introduced in 20.1.3. Unit is BYTES. RequestLength *int64 `json:"request_length,omitempty"` // Length of the response received in bytes. Field introduced in 20.1.3. Unit is BYTES. ResponseLength *int64 `json:"response_length,omitempty"` // The IP of the server that was used for the request. Field introduced in 20.1.3. ServerIP *int32 `json:"server_ip,omitempty"` // The name of the server that was used for the request. Field introduced in 20.1.3. ServerName *string `json:"server_name,omitempty"` // The port of the server that was used for the request. Field introduced in 20.1.3. ServerPort *int32 `json:"server_port,omitempty"` // Number of servers tried during server reselect before the response is sent back. Field introduced in 20.1.3. ServersTried *int32 `json:"servers_tried,omitempty"` // The source port for this request. Field introduced in 20.1.3. SourcePort *int32 `json:"source_port,omitempty"` // Total time taken to process the Out-of-Band request. This is the time taken from the 1st byte of the request sent to the last byte of the response received. Field introduced in 20.1.3. Unit is MILLISECONDS. TotalTime *int64 `json:"total_time,omitempty"` // The URI path of the out-of-band request. Field introduced in 20.1.3. URIPath *string `json:"uri_path,omitempty"` // The URI query of the out-of-band request. Field introduced in 20.1.3. URIQuery *string `json:"uri_query,omitempty"` }
DSRequestLog d s request log swagger:model DSRequestLog
type DataScriptErrorTrace ¶
type DataScriptErrorTrace struct { // error of DataScriptErrorTrace. Error *string `json:"error,omitempty"` // event of DataScriptErrorTrace. Event *string `json:"event,omitempty"` // stack_trace of DataScriptErrorTrace. StackTrace *string `json:"stack_trace,omitempty"` }
DataScriptErrorTrace data script error trace swagger:model DataScriptErrorTrace
type DatabaseEventInfo ¶
type DatabaseEventInfo struct { // Component of the database(e.g. metrics). Field introduced in 21.1.1. Component *string `json:"component,omitempty"` // Reported message of the event. Field introduced in 21.1.1. Message *string `json:"message,omitempty"` }
DatabaseEventInfo database event info swagger:model DatabaseEventInfo
type DbAppLearningInfo ¶
type DbAppLearningInfo struct { // Application UUID. Combination of Virtualservice UUID and WAF Policy UUID. Field introduced in 20.1.1. AppID *string `json:"app_id,omitempty"` // Information about various URIs under a application. Field introduced in 20.1.1. URIInfo []*URIInfo `json:"uri_info,omitempty"` // Virtualserivce UUID. Field introduced in 20.1.1. VsUUID *string `json:"vs_uuid,omitempty"` }
DbAppLearningInfo db app learning info swagger:model DbAppLearningInfo
type DebugController ¶
type DebugController struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Placeholder for description of property filters of obj type DebugController field type str type object Filters *DebugFilterUnion `json:"filters,omitempty"` // Enum options - LOG_LEVEL_DISABLED, LOG_LEVEL_INFO, LOG_LEVEL_WARNING, LOG_LEVEL_ERROR. // Required: true LogLevel *string `json:"log_level"` // Name of the object. // Required: true Name *string `json:"name"` // Enum options - TASK_QUEUE_DEBUG. RPC_INFRA_DEBUG. JOB_MGR_DEBUG. TRANSACTION_DEBUG. SE_AGENT_DEBUG. SE_AGENT_METRICS_DEBUG. VIRTUALSERVICE_DEBUG. RES_MGR_DEBUG. SE_MGR_DEBUG. VI_MGR_DEBUG. METRICS_MANAGER_DEBUG. METRICS_MGR_DEBUG. EVENT_API_DEBUG. HS_MGR_DEBUG. ALERT_MGR_DEBUG. AUTOSCALE_MGR_DEBUG. APIC_AGENT_DEBUG. REDIS_INFRA_DEBUG. CLOUD_CONNECTOR_DEBUG. MESOS_METRICS_DEBUG... // Required: true SubModule *string `json:"sub_module"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - TRACE_LEVEL_DISABLED, TRACE_LEVEL_ERROR, TRACE_LEVEL_DEBUG, TRACE_LEVEL_DEBUG_DETAIL. // Required: true TraceLevel *string `json:"trace_level"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
DebugController debug controller swagger:model DebugController
type DebugControllerAPIResponse ¶
type DebugControllerAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*DebugController `json:"results,omitempty"` }
DebugControllerAPIResponse debug controller Api response swagger:model DebugControllerApiResponse
type DebugDNSOptions ¶
type DebugDNSOptions struct { // This field filters the FQDN for Dns debug. Field introduced in 18.2.1. Maximum of 1 items allowed. DomainName []string `json:"domain_name,omitempty"` // This field filters the Gslb service for Dns debug. Field introduced in 18.2.1. Maximum of 1 items allowed. GslbServiceName []string `json:"gslb_service_name,omitempty"` }
DebugDNSOptions debug Dns options swagger:model DebugDnsOptions
type DebugFilterUnion ¶
type DebugFilterUnion struct { // Placeholder for description of property alert_debug_filter of obj type DebugFilterUnion field type str type object AlertDebugFilter *AlertMgrDebugFilter `json:"alert_debug_filter,omitempty"` // Placeholder for description of property autoscale_mgr_debug_filter of obj type DebugFilterUnion field type str type object AutoscaleMgrDebugFilter *AutoScaleMgrDebugFilter `json:"autoscale_mgr_debug_filter,omitempty"` // Placeholder for description of property cloud_connector_debug_filter of obj type DebugFilterUnion field type str type object CloudConnectorDebugFilter *CloudConnectorDebugFilter `json:"cloud_connector_debug_filter,omitempty"` // Placeholder for description of property hs_debug_filter of obj type DebugFilterUnion field type str type object HsDebugFilter *HSMgrDebugFilter `json:"hs_debug_filter,omitempty"` // Placeholder for description of property mesos_metrics_debug_filter of obj type DebugFilterUnion field type str type object MesosMetricsDebugFilter *MesosMetricsDebugFilter `json:"mesos_metrics_debug_filter,omitempty"` // Placeholder for description of property metrics_debug_filter of obj type DebugFilterUnion field type str type object MetricsDebugFilter *MetricsMgrDebugFilter `json:"metrics_debug_filter,omitempty"` // Add Metricsapi Server filter. Field introduced in 18.2.3. MetricsapiSrvDebugFilter *MetricsAPISrvDebugFilter `json:"metricsapi_srv_debug_filter,omitempty"` // Placeholder for description of property se_mgr_debug_filter of obj type DebugFilterUnion field type str type object SeMgrDebugFilter *SeMgrDebugFilter `json:"se_mgr_debug_filter,omitempty"` // Add SE RPC Proxy Filter. Field introduced in 18.1.5, 18.2.1. SeRPCProxyFilter *SeRPCProxyDebugFilter `json:"se_rpc_proxy_filter,omitempty"` // Add Metricsapi Server filter. Field introduced in 18.2.6. SecuritymgrDebugFilter *SecurityMgrDebugFilter `json:"securitymgr_debug_filter,omitempty"` // Placeholder for description of property state_cache_mgr_debug_filter of obj type DebugFilterUnion field type str type object StateCacheMgrDebugFilter *StateCacheMgrDebugFilter `json:"state_cache_mgr_debug_filter,omitempty"` // Enum options - TASK_QUEUE_DEBUG. RPC_INFRA_DEBUG. JOB_MGR_DEBUG. TRANSACTION_DEBUG. SE_AGENT_DEBUG. SE_AGENT_METRICS_DEBUG. VIRTUALSERVICE_DEBUG. RES_MGR_DEBUG. SE_MGR_DEBUG. VI_MGR_DEBUG. METRICS_MANAGER_DEBUG. METRICS_MGR_DEBUG. EVENT_API_DEBUG. HS_MGR_DEBUG. ALERT_MGR_DEBUG. AUTOSCALE_MGR_DEBUG. APIC_AGENT_DEBUG. REDIS_INFRA_DEBUG. CLOUD_CONNECTOR_DEBUG. MESOS_METRICS_DEBUG... // Required: true Type *string `json:"type"` // Placeholder for description of property vs_debug_filter of obj type DebugFilterUnion field type str type object VsDebugFilter *VsDebugFilter `json:"vs_debug_filter,omitempty"` }
DebugFilterUnion debug filter union swagger:model DebugFilterUnion
type DebugIPAddr ¶
type DebugIPAddr struct { // Placeholder for description of property addrs of obj type DebugIpAddr field type str type object Addrs []*IPAddr `json:"addrs,omitempty"` // Placeholder for description of property prefixes of obj type DebugIpAddr field type str type object Prefixes []*IPAddrPrefix `json:"prefixes,omitempty"` // Placeholder for description of property ranges of obj type DebugIpAddr field type str type object Ranges []*IPAddrRange `json:"ranges,omitempty"` }
DebugIPAddr debug Ip addr swagger:model DebugIpAddr
type DebugSeAgent ¶
type DebugSeAgent struct { // Log every nth message. Field introduced in 17.2.7. LogEveryN *int32 `json:"log_every_n,omitempty"` // Enum options - LOG_LEVEL_DISABLED, LOG_LEVEL_INFO, LOG_LEVEL_WARNING, LOG_LEVEL_ERROR. // Required: true LogLevel *string `json:"log_level"` // Enum options - TASK_QUEUE_DEBUG. RPC_INFRA_DEBUG. JOB_MGR_DEBUG. TRANSACTION_DEBUG. SE_AGENT_DEBUG. SE_AGENT_METRICS_DEBUG. VIRTUALSERVICE_DEBUG. RES_MGR_DEBUG. SE_MGR_DEBUG. VI_MGR_DEBUG. METRICS_MANAGER_DEBUG. METRICS_MGR_DEBUG. EVENT_API_DEBUG. HS_MGR_DEBUG. ALERT_MGR_DEBUG. AUTOSCALE_MGR_DEBUG. APIC_AGENT_DEBUG. REDIS_INFRA_DEBUG. CLOUD_CONNECTOR_DEBUG. MESOS_METRICS_DEBUG... // Required: true SubModule *string `json:"sub_module"` // Enum options - TRACE_LEVEL_DISABLED, TRACE_LEVEL_ERROR, TRACE_LEVEL_DEBUG, TRACE_LEVEL_DEBUG_DETAIL. // Required: true TraceLevel *string `json:"trace_level"` }
DebugSeAgent debug se agent swagger:model DebugSeAgent
type DebugSeCPUShares ¶
type DebugSeCPUShares struct { // Required: true CPU *int32 `json:"cpu"` // Required: true Shares *int32 `json:"shares"` }
DebugSeCPUShares debug se Cpu shares swagger:model DebugSeCpuShares
type DebugSeDataplane ¶
type DebugSeDataplane struct { // Enum options - DEBUG_DISPATCHER_FLOW. DEBUG_DISPATCHER_FLOW_DETAIL. DEBUG_DISPATCHER_FLOW_ALL. DEBUG_CONFIG. DEBUG_IP. DEBUG_IP_PKT_IN. DEBUG_IP_PKT_OUT. DEBUG_ARP. DEBUG_ARP_PKT_IN. DEBUG_ARP_PKT_OUT. DEBUG_ETHERNET. DEBUG_ETHERNET_PKT_IN. DEBUG_ETHERNET_PKT_OUT. DEBUG_ICMP. DEBUG_PCAP_RX. DEBUG_PCAP_TX. DEBUG_PCAP_DROP. DEBUG_PCAP_ALL. DEBUG_MISC. DEBUG_CRUD... // Required: true Flag *string `json:"flag"` }
DebugSeDataplane debug se dataplane swagger:model DebugSeDataplane
type DebugSeFault ¶
type DebugSeFault struct { // Set of faults to enable/disable. Field introduced in 20.1.1. Faults []*SeFault `json:"faults,omitempty"` // Fail SE malloc type at this frequency. Field introduced in 18.1.2. SeMallocFailFrequency *int32 `json:"se_malloc_fail_frequency,omitempty"` // Fail this SE malloc type. Field introduced in 18.1.2. SeMallocFailType *int32 `json:"se_malloc_fail_type,omitempty"` // Toggle assert on mbuf cluster sanity check fail. Field introduced in 17.2.13,18.1.3,18.2.1. SeMbufClSanity *bool `json:"se_mbuf_cl_sanity,omitempty"` // Fail SE SHM malloc type at this frequency. Field introduced in 18.1.2. SeShmMallocFailFrequency *int32 `json:"se_shm_malloc_fail_frequency,omitempty"` // Fail this SE SHM malloc type. Field introduced in 18.1.2. SeShmMallocFailType *int32 `json:"se_shm_malloc_fail_type,omitempty"` // Fail SE WAF allocation at this frequency. Field introduced in 18.1.2. SeWafAllocFailFrequency *int32 `json:"se_waf_alloc_fail_frequency,omitempty"` // Fail SE WAF learning allocation at this frequency. Field introduced in 18.1.2. SeWafLearningAllocFailFrequency *int32 `json:"se_waf_learning_alloc_fail_frequency,omitempty"` }
DebugSeFault debug se fault swagger:model DebugSeFault
type DebugServiceEngine ¶
type DebugServiceEngine struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Action to be invoked at configured layer. Enum options - SE_BENCHMARK_MODE_DROP, SE_BENCHMARK_MODE_REFLECT. Field introduced in 20.1.3. BenchmarkAction *string `json:"benchmark_action,omitempty"` // Toggle and configure the layer to benchmark performance. This can be done at a specific point in the SE packet processing pipeline. Enum options - SE_BENCHMARK_LAYER_NONE, SE_BENCHMARK_LAYER_POST_VNIC_RX, SE_BENCHMARK_LAYER_POST_FT_LOOKUP, SE_BENCHMARK_LAYER_NSP_LOOKUP, SE_BENCHMARK_LAYER_PRE_PROXY_PUNT, SE_BENCHMARK_LAYER_POST_PROXY_PUNT, SE_BENCHMARK_LAYER_ETHER_INPUT, SE_BENCHMARK_LAYER_IP_INPUT, SE_BENCHMARK_LAYER_UDP_INPUT. Field introduced in 20.1.3. BenchmarkLayer *string `json:"benchmark_layer,omitempty"` // Configure different reflect modes. Enum options - SE_BENCHMARK_REFLECT_SWAP_L4, SE_BENCHMARK_REFLECT_SWAP_L2, SE_BENCHMARK_REFLECT_SWAP_L3. Field introduced in 20.1.3. BenchmarkOption *string `json:"benchmark_option,omitempty"` // RSS Hash function to be used for packet reflect in TX path. Enum options - SE_BENCHMARK_DISABLE_HASH, SE_BENCHMARK_RTE_SOFT_HASH. Field introduced in 20.1.3. BenchmarkRssHash *string `json:"benchmark_rss_hash,omitempty"` // Enable/disable packet capture. Field introduced in 18.2.2. Capture *bool `json:"capture,omitempty"` // Per packet capture filters for Debug Service Engine. Not applicable for DOS pcap capture. . Field introduced in 18.2.5. CaptureFilters *CaptureFilters `json:"capture_filters,omitempty"` // Params for SE pcap. Field introduced in 17.2.14,18.1.5,18.2.1. CaptureParams *DebugVirtualServiceCapture `json:"capture_params,omitempty"` CPUShares []*DebugSeCPUShares `json:"cpu_shares,omitempty"` // Per packet IP filter for Service Engine PCAP. Matches with source and destination address. Field introduced in 17.2.14,18.1.5,18.2.1. DebugIP *DebugIPAddr `json:"debug_ip,omitempty"` // Enables the use of kdump on SE. Requires SE Reboot. Applicable only in case of VM Based deployments. Field introduced in 18.2.10, 20.1.1. EnableKdump *bool `json:"enable_kdump,omitempty"` // Params for SE fault injection. Field introduced in 18.1.2. Fault *DebugSeFault `json:"fault,omitempty"` // Placeholder for description of property flags of obj type DebugServiceEngine field type str type object Flags []*DebugSeDataplane `json:"flags,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Placeholder for description of property seagent_debug of obj type DebugServiceEngine field type str type object SeagentDebug []*DebugSeAgent `json:"seagent_debug,omitempty"` // Debug knob for se_log_agent process. Field introduced in 20.1.1. SelogagentDebug *DebugSeAgent `json:"selogagent_debug,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
DebugServiceEngine debug service engine swagger:model DebugServiceEngine
type DebugServiceEngineAPIResponse ¶
type DebugServiceEngineAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*DebugServiceEngine `json:"results,omitempty"` }
DebugServiceEngineAPIResponse debug service engine Api response swagger:model DebugServiceEngineApiResponse
type DebugVirtualService ¶
type DebugVirtualService struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Placeholder for description of property capture of obj type DebugVirtualService field type str type boolean Capture *bool `json:"capture,omitempty"` // Per packet capture filters for Debug Virtual Service. Applies to both frontend and backend packets. Field introduced in 18.2.7. CaptureFilters *CaptureFilters `json:"capture_filters,omitempty"` // Placeholder for description of property capture_params of obj type DebugVirtualService field type str type object CaptureParams *DebugVirtualServiceCapture `json:"capture_params,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // This option controls the capture of Health Monitor flows. Enum options - DEBUG_VS_HM_NONE, DEBUG_VS_HM_ONLY, DEBUG_VS_HM_INCLUDE. DebugHm *string `json:"debug_hm,omitempty"` // Filters all packets of a complete transaction (client and server side), based on client ip. DebugIP *DebugIPAddr `json:"debug_ip,omitempty"` // Dns debug options. Field introduced in 18.2.1. DNSOptions *DebugDNSOptions `json:"dns_options,omitempty"` // Placeholder for description of property flags of obj type DebugVirtualService field type str type object Flags []*DebugVsDataplane `json:"flags,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Object sync debug options. Field introduced in 20.1.3. Objsync *DebugVirtualServiceObjSync `json:"objsync,omitempty"` // This option re-synchronizes flows between Active-Standby service engines for all the virtual services placed on them. It should be used with caution because as it can cause a flood between Active-Standby. Field introduced in 18.1.3,18.2.1. ResyncFlows *bool `json:"resync_flows,omitempty"` // Placeholder for description of property se_params of obj type DebugVirtualService field type str type object SeParams *DebugVirtualServiceSeParams `json:"se_params,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
DebugVirtualService debug virtual service swagger:model DebugVirtualService
type DebugVirtualServiceAPIResponse ¶
type DebugVirtualServiceAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*DebugVirtualService `json:"results,omitempty"` }
DebugVirtualServiceAPIResponse debug virtual service Api response swagger:model DebugVirtualServiceApiResponse
type DebugVirtualServiceCapture ¶
type DebugVirtualServiceCapture struct { // Maximum allowed size of PCAP Capture File per SE. Max(absolute_size, percentage_size) will be final value. Set both to 0 for avi default size. DOS, IPC and DROP pcaps not applicaple. Field introduced in 18.2.8. CaptureFileSize *CaptureFileSize `json:"capture_file_size,omitempty"` // Number of minutes to capture packets. Use 0 to capture until manually stopped. Special values are 0 - 'infinite'. Unit is MIN. Duration *int32 `json:"duration,omitempty"` // Enable SSL session key capture. Field introduced in 18.2.3. EnableSslSessionKeyCapture *bool `json:"enable_ssl_session_key_capture,omitempty"` // Number of files to maintain for SE pcap file rotation.file count set to 1 indicates no rotate. Allowed values are 1-10. Field introduced in 20.1.1. FileCount *int32 `json:"file_count,omitempty"` // Total number of packets to capture. NumPkts *int32 `json:"num_pkts,omitempty"` // Enable PcapNg for packet capture. Field introduced in 18.2.5. PcapNg *bool `json:"pcap_ng,omitempty"` // Number of bytes of each packet to capture. Use 0 to capture the entire packet. Allowed values are 64-1514. Special values are 0 - 'full capture'. Unit is BYTES. PktSize *int32 `json:"pkt_size,omitempty"` }
DebugVirtualServiceCapture debug virtual service capture swagger:model DebugVirtualServiceCapture
type DebugVirtualServiceObjSync ¶
type DebugVirtualServiceObjSync struct { // Triggers Initial Sync on all the SEs of this VS. Field introduced in 20.1.3. TriggerInitialSync *bool `json:"trigger_initial_sync,omitempty"` }
DebugVirtualServiceObjSync debug virtual service obj sync swagger:model DebugVirtualServiceObjSync
type DebugVirtualServiceSeParams ¶
type DebugVirtualServiceSeParams struct { // It is a reference to an object of type ServiceEngine. SeRefs []string `json:"se_refs,omitempty"` }
DebugVirtualServiceSeParams debug virtual service se params swagger:model DebugVirtualServiceSeParams
type DebugVrf ¶
type DebugVrf struct { // Enum options - DEBUG_VRF_BGP, DEBUG_VRF_QUAGGA, DEBUG_VRF_ALL, DEBUG_VRF_NONE. Field introduced in 17.1.1. // Required: true Flag *string `json:"flag"` }
DebugVrf debug vrf swagger:model DebugVrf
type DebugVrfContext ¶
type DebugVrfContext struct { // Vrf config command buffer process interval. Allowed values are 1-4. Field introduced in 17.2.13,18.1.5,18.2.1. Unit is SECONDS. CommandBufferInterval *int32 `json:"command_buffer_interval,omitempty"` // Vrf config command buffer size. Allowed values are 1-32768. Field introduced in 17.2.13,18.1.5,18.2.1. Unit is BYTES. CommandBufferSize *int32 `json:"command_buffer_size,omitempty"` // Field introduced in 17.1.1. Flags []*DebugVrf `json:"flags,omitempty"` }
DebugVrfContext debug vrf context swagger:model DebugVrfContext
type DebugVsDataplane ¶
type DebugVsDataplane struct { // Enum options - DEBUG_VS_TCP_CONNECTION. DEBUG_VS_TCP_PKT. DEBUG_VS_TCP_APP. DEBUG_VS_TCP_APP_PKT. DEBUG_VS_TCP_RETRANSMIT. DEBUG_VS_TCP_TIMER. DEBUG_VS_TCP_CONN_ERROR. DEBUG_VS_TCP_PKT_ERROR. DEBUG_VS_TCP_REXMT. DEBUG_VS_TCP_ALL. DEBUG_VS_CREDIT. DEBUG_VS_PROXY_CONNECTION. DEBUG_VS_PROXY_PKT. DEBUG_VS_PROXY_ERR. DEBUG_VS_UDP. DEBUG_VS_UDP_PKT. DEBUG_VS_HM. DEBUG_VS_HM_ERR. DEBUG_VS_HM_PKT. DEBUG_VS_HTTP_CORE... // Required: true Flag *string `json:"flag"` }
DebugVsDataplane debug vs dataplane swagger:model DebugVsDataplane
type DisableSeMigrateEventDetails ¶
type DisableSeMigrateEventDetails struct { // Placeholder for description of property migrate_params of obj type DisableSeMigrateEventDetails field type str type object MigrateParams *VsMigrateParams `json:"migrate_params,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
DisableSeMigrateEventDetails disable se migrate event details swagger:model DisableSeMigrateEventDetails
type DiscoveredNetwork ¶
type DiscoveredNetwork struct { // Discovered network for this IP. It is a reference to an object of type Network. // Required: true NetworkRef *string `json:"network_ref"` // Discovered subnet for this IP. Subnet []*IPAddrPrefix `json:"subnet,omitempty"` // Discovered IPv6 subnet for this IP. Field introduced in 18.1.1. Subnet6 []*IPAddrPrefix `json:"subnet6,omitempty"` }
DiscoveredNetwork discovered network swagger:model DiscoveredNetwork
type DispatcherTableDumpClear ¶
type DispatcherTableDumpClear struct { // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` }
DispatcherTableDumpClear dispatcher table dump clear swagger:model DispatcherTableDumpClear
type DockerConfiguration ¶
type DockerConfiguration struct { // Sync frequency in seconds with frameworks. AppSyncFrequency *int32 `json:"app_sync_frequency,omitempty"` // UUID of the UCP CA TLS cert and key. It is a reference to an object of type SSLKeyAndCertificate. CaTLSKeyAndCertificateRef *string `json:"ca_tls_key_and_certificate_ref,omitempty"` // UUID of the client TLS cert and key. It is a reference to an object of type SSLKeyAndCertificate. ClientTLSKeyAndCertificateRef *string `json:"client_tls_key_and_certificate_ref,omitempty"` // Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService. ContainerPortMatchHTTPService *bool `json:"container_port_match_http_service,omitempty"` // Directory to mount to check for core dumps on Service Engines. This will be mapped read only to /var/crash on any new Service Engines. This is a disruptive change. CoredumpDirectory *string `json:"coredump_directory,omitempty"` // Disable auto service sync for back end services. DisableAutoBackendServiceSync *bool `json:"disable_auto_backend_service_sync,omitempty"` // Disable auto service sync for front end services. DisableAutoFrontendServiceSync *bool `json:"disable_auto_frontend_service_sync,omitempty"` // Disable SE creation. DisableAutoSeCreation *bool `json:"disable_auto_se_creation,omitempty"` // Docker registry for ServiceEngine image. DockerRegistrySe *DockerRegistry `json:"docker_registry_se,omitempty"` // Match against this prefix when placing east-west VSs on SEs . EastWestPlacementSubnet *IPAddrPrefix `json:"east_west_placement_subnet,omitempty"` // Enable Docker event subscription. EnableEventSubscription *bool `json:"enable_event_subscription,omitempty"` // For Front End proxies, use container port as service port. FeproxyContainerPortAsService *bool `json:"feproxy_container_port_as_service,omitempty"` // Enable proxy ARP from Host interface for Front End proxies. FeproxyVipsEnableProxyArp *bool `json:"feproxy_vips_enable_proxy_arp,omitempty"` // Optional fleet remote endpoint if fleet is used for SE deployment. FleetEndpoint *string `json:"fleet_endpoint,omitempty"` // List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80. HTTPContainerPorts []int64 `json:"http_container_ports,omitempty,omitempty"` // Use Fleet/SSH for SE deployment. Enum options - SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD. SeDeploymentMethod *string `json:"se_deployment_method,omitempty"` // Exclude hosts with attributes for SE creation. SeExcludeAttributes []*MesosAttribute `json:"se_exclude_attributes,omitempty"` // Create SEs just on hosts with include attributes. SeIncludeAttributes []*MesosAttribute `json:"se_include_attributes,omitempty"` // New SE spawn rate per minute. SeSpawnRate *int32 `json:"se_spawn_rate,omitempty"` // Host volume to be used as a disk for Avi SE, This is a disruptive change. SeVolume *string `json:"se_volume,omitempty"` // Make service ports accessible on all Host interfaces in addition to East-West VIP and/or bridge IP. Usually enabled AWS clusters to export East-West services on Host interface. ServicesAccessibleAllInterfaces *bool `json:"services_accessible_all_interfaces,omitempty"` // Parameters for SSH SE deployment. Field deprecated in 17.1.1. SSHSeDeployment *SSHSeDeployment `json:"ssh_se_deployment,omitempty"` // Cloud connector user uuid for SSH to hosts. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.1.1. SSHUserRef *string `json:"ssh_user_ref,omitempty"` // List of Docker UCP nodes; In case of a load balanced UCP cluster, use Virtual IP of the cluster. UcpNodes []string `json:"ucp_nodes,omitempty"` // Use container IP address port for pool instead of host IP address hostport. This mode is applicable if the container IP is reachable (not a private NATed IP) from other hosts in a routed environment for containers. UseContainerIPPort *bool `json:"use_container_ip_port,omitempty"` // If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se. UseControllerImage *bool `json:"use_controller_image,omitempty"` }
DockerConfiguration docker configuration swagger:model DockerConfiguration
type DockerRegistry ¶
type DockerRegistry struct { // Openshift integrated registry config. OshiftRegistry *OshiftDockerRegistryMetaData `json:"oshift_registry,omitempty"` // Password for docker registry. Authorized 'regular user' password if registry is Openshift integrated registry. Password *string `json:"password,omitempty"` // Set if docker registry is private. Avi controller will not attempt to push SE image to the registry, unless se_repository_push is set. Private *bool `json:"private,omitempty"` // Avi ServiceEngine repository name. For private registry, it's registry port/repository, for public registry, it's registry/repository, for openshift registry, it's registry port/namespace/repo. Registry *string `json:"registry,omitempty"` // Avi Controller will push ServiceEngine image to docker repository. Field deprecated in 18.2.6. SeRepositoryPush *bool `json:"se_repository_push,omitempty"` // Username for docker registry. Authorized 'regular user' if registry is Openshift integrated registry. Username *string `json:"username,omitempty"` }
DockerRegistry docker registry swagger:model DockerRegistry
type DockerUCPSetup ¶
type DockerUCPSetup struct { // cc_id of DockerUCPSetup. CcID *string `json:"cc_id,omitempty"` // Placeholder for description of property docker_ucp_access of obj type DockerUCPSetup field type str type boolean DockerUcpAccess *bool `json:"docker_ucp_access,omitempty"` // failed_hosts of DockerUCPSetup. FailedHosts []string `json:"failed_hosts,omitempty"` // fleet_endpoint of DockerUCPSetup. FleetEndpoint *string `json:"fleet_endpoint,omitempty"` // hosts of DockerUCPSetup. Hosts []string `json:"hosts,omitempty"` // missing_hosts of DockerUCPSetup. MissingHosts []string `json:"missing_hosts,omitempty"` // new_hosts of DockerUCPSetup. NewHosts []string `json:"new_hosts,omitempty"` // reason of DockerUCPSetup. Reason *string `json:"reason,omitempty"` // Placeholder for description of property se_deploy_method_access of obj type DockerUCPSetup field type str type boolean SeDeployMethodAccess *bool `json:"se_deploy_method_access,omitempty"` // se_name of DockerUCPSetup. SeName *string `json:"se_name,omitempty"` // ucp_nodes of DockerUCPSetup. UcpNodes []string `json:"ucp_nodes,omitempty"` // version of DockerUCPSetup. Version *string `json:"version,omitempty"` }
DockerUCPSetup docker u c p setup swagger:model DockerUCPSetup
type DosAttackEventDetails ¶
type DosAttackEventDetails struct { // Enum options - LAND. SMURF. ICMP_PING_FLOOD. UNKOWN_PROTOCOL. TEARDROP. IP_FRAG_OVERRUN. IP_FRAG_TOOSMALL. IP_FRAG_FULL. IP_FRAG_INCOMPLETE. PORT_SCAN. TCP_NON_SYN_FLOOD_OLD. SYN_FLOOD. BAD_RST_FLOOD. MALFORMED_FLOOD. FAKE_SESSION. ZERO_WINDOW_STRESS. SMALL_WINDOW_STRESS. DOS_HTTP_TIMEOUT. DOS_HTTP_ERROR. DOS_HTTP_ABORT... // Required: true Attack *string `json:"attack"` // Placeholder for description of property attack_count of obj type DosAttackEventDetails field type str type number // Required: true AttackCount *float64 `json:"attack_count"` // Unique object identifiers of ipgroups. IpgroupUuids []string `json:"ipgroup_uuids,omitempty"` // Placeholder for description of property meta_data of obj type DosAttackEventDetails field type str type object MetaData []*AttackMetaData `json:"meta_data,omitempty"` // src_ips of DosAttackEventDetails. SrcIps []string `json:"src_ips,omitempty"` // urls of DosAttackEventDetails. Urls []string `json:"urls,omitempty"` }
DosAttackEventDetails dos attack event details swagger:model DosAttackEventDetails
type DosRateLimitProfile ¶
type DosRateLimitProfile struct { // Profile for DoS attack detection. DosProfile *DosThresholdProfile `json:"dos_profile,omitempty"` // Profile for Connections/Requests rate limiting. RlProfile *RateLimiterProfile `json:"rl_profile,omitempty"` }
DosRateLimitProfile dos rate limit profile swagger:model DosRateLimitProfile
type DosThreshold ¶
type DosThreshold struct { // Attack type. Enum options - LAND, SMURF, ICMP_PING_FLOOD, UNKOWN_PROTOCOL, TEARDROP, IP_FRAG_OVERRUN, IP_FRAG_TOOSMALL, IP_FRAG_FULL, IP_FRAG_INCOMPLETE, PORT_SCAN, TCP_NON_SYN_FLOOD_OLD, SYN_FLOOD, BAD_RST_FLOOD, MALFORMED_FLOOD, FAKE_SESSION, ZERO_WINDOW_STRESS, SMALL_WINDOW_STRESS, DOS_HTTP_TIMEOUT, DOS_HTTP_ERROR, DOS_HTTP_ABORT... // Required: true Attack *string `json:"attack"` // Maximum number of packets or connections or requests in a given interval of time to be deemed as attack. // Required: true MaxValue *int32 `json:"max_value"` // Minimum number of packets or connections or requests in a given interval of time to be deemed as attack. // Required: true MinValue *int32 `json:"min_value"` }
DosThreshold dos threshold swagger:model DosThreshold
type DosThresholdProfile ¶
type DosThresholdProfile struct { // Attack type, min and max values for DoS attack detection. ThreshInfo []*DosThreshold `json:"thresh_info,omitempty"` // Timer value in seconds to collect DoS attack metrics based on threshold on the Service Engine for this Virtual Service. Unit is SEC. // Required: true ThreshPeriod *int32 `json:"thresh_period"` }
DosThresholdProfile dos threshold profile swagger:model DosThresholdProfile
type DsrProfile ¶
type DsrProfile struct { // Encapsulation type to use when DSR is L3. Enum options - ENCAP_IPINIP. Field introduced in 18.2.3. // Required: true DsrEncapType *string `json:"dsr_encap_type"` // DSR type L2/L3. Enum options - DSR_TYPE_L2, DSR_TYPE_L3. Field introduced in 18.2.3. // Required: true DsrType *string `json:"dsr_type"` }
DsrProfile dsr profile swagger:model DsrProfile
type DynamicDNSRecord ¶
type DynamicDNSRecord struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Specifies the algorithm to pick the IP address(es) to be returned,when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is round-robin. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 20.1.3. Algorithm *string `json:"algorithm,omitempty"` // Canonical name in CNAME record. Field introduced in 20.1.3. Cname *DNSCnameRdata `json:"cname,omitempty"` // Configured FQDNs are delegated domains (i.e. they represent a zone cut). Field introduced in 20.1.3. Delegated *bool `json:"delegated,omitempty"` // Details of DNS record. Field introduced in 20.1.3. Description *string `json:"description,omitempty"` // UUID of the DNS VS. Field introduced in 20.1.3. DNSVsUUID *string `json:"dns_vs_uuid,omitempty"` // Fully Qualified Domain Name. Field introduced in 20.1.3. Fqdn *string `json:"fqdn,omitempty"` // IPv6 address in AAAA record. Field introduced in 20.1.3. Maximum of 4 items allowed. Ip6Address []*DNSAAAARdata `json:"ip6_address,omitempty"` // IP address in A record. Field introduced in 20.1.3. Maximum of 4 items allowed. IPAddress []*DNSARdata `json:"ip_address,omitempty"` // Internal metadata for the DNS record. Field introduced in 20.1.3. Metadata *string `json:"metadata,omitempty"` // MX record. Field introduced in 20.1.3. Maximum of 4 items allowed. MxRecords []*DNSMxRdata `json:"mx_records,omitempty"` // DynamicDnsRecord name, needed for a top level uuid protobuf, for display in shell. Field introduced in 20.1.3. Name *string `json:"name,omitempty"` // Name Server information in NS record. Field introduced in 20.1.3. Maximum of 13 items allowed. Ns []*DNSNsRdata `json:"ns,omitempty"` // Specifies the number of records returned by the DNS service.Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- 'Return all records'. Field introduced in 20.1.3. NumRecordsInResponse *int32 `json:"num_records_in_response,omitempty"` // Service locator info in SRV record. Field introduced in 20.1.3. Maximum of 4 items allowed. ServiceLocators []*DNSSrvRdata `json:"service_locators,omitempty"` // tenant_uuid from Dns VS's tenant_uuid. It is a reference to an object of type Tenant. Field introduced in 20.1.3. TenantRef *string `json:"tenant_ref,omitempty"` // Time To Live for this DNS record. Field introduced in 20.1.3. TTL *int32 `json:"ttl,omitempty"` // Text record. Field introduced in 20.1.3. Maximum of 4 items allowed. TxtRecords []*DNSTxtRdata `json:"txt_records,omitempty"` // DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Field introduced in 20.1.3. Type *string `json:"type,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the dns record. Field introduced in 20.1.3. UUID *string `json:"uuid,omitempty"` // Enable wild-card match of fqdn if an exact match is not found in the DNS table, the longest match is chosen by wild-carding the fqdn in the DNS request. Default is false. Field introduced in 20.1.3. WildcardMatch *bool `json:"wildcard_match,omitempty"` }
DynamicDNSRecord dynamic Dns record swagger:model DynamicDnsRecord
type DynamicDNSRecordAPIResponse ¶
type DynamicDNSRecordAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*DynamicDNSRecord `json:"results,omitempty"` }
DynamicDNSRecordAPIResponse dynamic Dns record Api response swagger:model DynamicDnsRecordApiResponse
type EmailConfiguration ¶
type EmailConfiguration struct { // Password for mail server. AuthPassword *string `json:"auth_password,omitempty"` // Username for mail server. AuthUsername *string `json:"auth_username,omitempty"` // When set, disables TLS on the connection to the mail server. Field introduced in 17.2.12, 18.1.3, 18.2.1. DisableTLS *bool `json:"disable_tls,omitempty"` // Email address in From field. FromEmail *string `json:"from_email,omitempty"` // Mail server host. MailServerName *string `json:"mail_server_name,omitempty"` // Mail server port. MailServerPort *int32 `json:"mail_server_port,omitempty"` // Type of SMTP Mail Service. Enum options - SMTP_NONE, SMTP_LOCAL_HOST, SMTP_SERVER, SMTP_ANONYMOUS_SERVER. // Required: true SMTPType *string `json:"smtp_type"` }
EmailConfiguration email configuration swagger:model EmailConfiguration
type EquivalentLabels ¶
type EquivalentLabels struct { // Equivalent labels. Labels []string `json:"labels,omitempty"` }
EquivalentLabels equivalent labels swagger:model EquivalentLabels
type ErrorPage ¶
type ErrorPage struct { // Enable or disable the error page. Field introduced in 17.2.4. Enable *bool `json:"enable,omitempty"` // Custom error page body used to sent to the client. It is a reference to an object of type ErrorPageBody. Field introduced in 17.2.4. ErrorPageBodyRef *string `json:"error_page_body_ref,omitempty"` // Redirect sent to client when match. Field introduced in 17.2.4. ErrorRedirect *string `json:"error_redirect,omitempty"` // Index of the error page. Field introduced in 17.2.4. Index *int32 `json:"index,omitempty"` // Add match criteria for http status codes to the error page. Field introduced in 17.2.4. Allowed in Basic edition, Essentials edition, Enterprise edition. Match *HttpstatusMatch `json:"match,omitempty"` }
ErrorPage error page swagger:model ErrorPage
type ErrorPageBody ¶
type ErrorPageBody struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Error page body sent to client when match. Field introduced in 17.2.4. // Required: true ErrorPageBody *string `json:"error_page_body"` // Format of an error page body HTML or JSON. Enum options - ERROR_PAGE_FORMAT_HTML, ERROR_PAGE_FORMAT_JSON. Field introduced in 18.2.3. Format *string `json:"format,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Field introduced in 17.2.4. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 17.2.4. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 17.2.4. UUID *string `json:"uuid,omitempty"` }
ErrorPageBody error page body swagger:model ErrorPageBody
type ErrorPageBodyAPIResponse ¶
type ErrorPageBodyAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ErrorPageBody `json:"results,omitempty"` }
ErrorPageBodyAPIResponse error page body Api response swagger:model ErrorPageBodyApiResponse
type ErrorPageProfile ¶
type ErrorPageProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of the Virtual Service which generated the error page. Field deprecated in 18.1.1. Field introduced in 17.2.4. AppName *string `json:"app_name,omitempty"` // Name of the company to show in error page. Field deprecated in 18.1.1. Field introduced in 17.2.4. CompanyName *string `json:"company_name,omitempty"` // Defined Error Pages for HTTP status codes. Field introduced in 17.2.4. ErrorPages []*ErrorPage `json:"error_pages,omitempty"` // Fully qualified domain name for which the error page is generated. Field deprecated in 18.1.1. Field introduced in 17.2.4. HostName *string `json:"host_name,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.3. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Field introduced in 17.2.4. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 17.2.4. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 17.2.4. UUID *string `json:"uuid,omitempty"` }
ErrorPageProfile error page profile swagger:model ErrorPageProfile
type ErrorPageProfileAPIResponse ¶
type ErrorPageProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ErrorPageProfile `json:"results,omitempty"` }
ErrorPageProfileAPIResponse error page profile Api response swagger:model ErrorPageProfileApiResponse
type EventCache ¶
type EventCache struct { // Placeholder for description of property dns_state of obj type EventCache field type str type boolean DNSState *bool `json:"dns_state,omitempty"` // Cache the exception strings in the system. Exceptions []string `json:"exceptions,omitempty"` }
EventCache event cache swagger:model EventCache
type EventDetails ¶
type EventDetails struct { // Placeholder for description of property add_networks_details of obj type EventDetails field type str type object AddNetworksDetails *RmAddNetworksEventDetails `json:"add_networks_details,omitempty"` // Placeholder for description of property albservices_case_details of obj type EventDetails field type str type object AlbservicesCaseDetails *ALBServicesCase `json:"albservices_case_details,omitempty"` // Placeholder for description of property albservices_file_upload_details of obj type EventDetails field type str type object AlbservicesFileUploadDetails *ALBServicesFileUpload `json:"albservices_file_upload_details,omitempty"` // Placeholder for description of property albservices_status_details of obj type EventDetails field type str type object AlbservicesStatusDetails *ALBServicesStatusDetails `json:"albservices_status_details,omitempty"` // Placeholder for description of property all_seupgrade_event_details of obj type EventDetails field type str type object AllSeupgradeEventDetails *AllSeUpgradeEventDetails `json:"all_seupgrade_event_details,omitempty"` // Placeholder for description of property anomaly_details of obj type EventDetails field type str type object AnomalyDetails *AnomalyEventDetails `json:"anomaly_details,omitempty"` // Placeholder for description of property api_version_deprecated of obj type EventDetails field type str type object APIVersionDeprecated *APIVersionDeprecated `json:"api_version_deprecated,omitempty"` // Placeholder for description of property apic_agent_bd_vrf_details of obj type EventDetails field type str type object ApicAgentBdVrfDetails *ApicAgentBridgeDomainVrfChange `json:"apic_agent_bd_vrf_details,omitempty"` // Placeholder for description of property apic_agent_generic_details of obj type EventDetails field type str type object ApicAgentGenericDetails *ApicAgentGenericEventDetails `json:"apic_agent_generic_details,omitempty"` // Placeholder for description of property apic_agent_vs_network_error of obj type EventDetails field type str type object ApicAgentVsNetworkError *ApicAgentVsNetworkError `json:"apic_agent_vs_network_error,omitempty"` // Placeholder for description of property app_signature_event_data of obj type EventDetails field type str type object AppSignatureEventData *AppSignatureEventData `json:"app_signature_event_data,omitempty"` // Placeholder for description of property avg_uptime_change_details of obj type EventDetails field type str type object AvgUptimeChangeDetails *AvgUptimeChangeDetails `json:"avg_uptime_change_details,omitempty"` // Field introduced in 17.2.10,18.1.2. AwsAsgDeletionDetails *AWSASGDelete `json:"aws_asg_deletion_details,omitempty"` // Placeholder for description of property aws_asg_notif_details of obj type EventDetails field type str type object AwsAsgNotifDetails *AWSASGNotifDetails `json:"aws_asg_notif_details,omitempty"` // Placeholder for description of property aws_infra_details of obj type EventDetails field type str type object AwsInfraDetails *AWSSetup `json:"aws_infra_details,omitempty"` // Placeholder for description of property azure_info of obj type EventDetails field type str type object AzureInfo *AzureSetup `json:"azure_info,omitempty"` // Azure marketplace license term acceptance event. Field introduced in 18.2.2. AzureMpInfo *AzureMarketplace `json:"azure_mp_info,omitempty"` // Placeholder for description of property bind_vs_se_details of obj type EventDetails field type str type object BindVsSeDetails *RmBindVsSeEventDetails `json:"bind_vs_se_details,omitempty"` // Placeholder for description of property bm_infra_details of obj type EventDetails field type str type object BmInfraDetails *BMSetup `json:"bm_infra_details,omitempty"` // Placeholder for description of property bootup_fail_details of obj type EventDetails field type str type object BootupFailDetails *RmSeBootupFailEventDetails `json:"bootup_fail_details,omitempty"` // Placeholder for description of property burst_checkout_details of obj type EventDetails field type str type object BurstCheckoutDetails *BurstLicenseDetails `json:"burst_checkout_details,omitempty"` // Placeholder for description of property cc_cluster_vip_details of obj type EventDetails field type str type object CcClusterVipDetails *CloudClusterVip `json:"cc_cluster_vip_details,omitempty"` // Placeholder for description of property cc_dns_update_details of obj type EventDetails field type str type object CcDNSUpdateDetails *CloudDNSUpdate `json:"cc_dns_update_details,omitempty"` // Placeholder for description of property cc_health_details of obj type EventDetails field type str type object CcHealthDetails *CloudHealth `json:"cc_health_details,omitempty"` // Placeholder for description of property cc_infra_details of obj type EventDetails field type str type object CcInfraDetails *CloudGeneric `json:"cc_infra_details,omitempty"` // Placeholder for description of property cc_ip_details of obj type EventDetails field type str type object CcIPDetails *CloudIPChange `json:"cc_ip_details,omitempty"` // Placeholder for description of property cc_parkintf_details of obj type EventDetails field type str type object CcParkintfDetails *CloudVipParkingIntf `json:"cc_parkintf_details,omitempty"` // Field introduced in 18.2.5. CcScalesetNotifDetails *CCScaleSetNotifDetails `json:"cc_scaleset_notif_details,omitempty"` // Placeholder for description of property cc_se_vm_details of obj type EventDetails field type str type object CcSeVMDetails *CloudSeVMChange `json:"cc_se_vm_details,omitempty"` // Placeholder for description of property cc_sync_services_details of obj type EventDetails field type str type object CcSyncServicesDetails *CloudSyncServices `json:"cc_sync_services_details,omitempty"` // Placeholder for description of property cc_tenant_del_details of obj type EventDetails field type str type object CcTenantDelDetails *CloudTenantsDeleted `json:"cc_tenant_del_details,omitempty"` // Placeholder for description of property cc_vip_update_details of obj type EventDetails field type str type object CcVipUpdateDetails *CloudVipUpdate `json:"cc_vip_update_details,omitempty"` // Placeholder for description of property cc_vnic_details of obj type EventDetails field type str type object CcVnicDetails *CloudVnicChange `json:"cc_vnic_details,omitempty"` // Placeholder for description of property cloud_asg_notif_details of obj type EventDetails field type str type object CloudAsgNotifDetails *CloudASGNotifDetails `json:"cloud_asg_notif_details,omitempty"` // Placeholder for description of property cloud_autoscaling_config_failure_details of obj type EventDetails field type str type object CloudAutoscalingConfigFailureDetails *CloudAutoscalingConfigFailureDetails `json:"cloud_autoscaling_config_failure_details,omitempty"` // Cloud Routes event. Field introduced in 20.1.3. CloudRouteNotifDetails *CloudRouteNotifDetails `json:"cloud_route_notif_details,omitempty"` // Placeholder for description of property cluster_config_failed_details of obj type EventDetails field type str type object ClusterConfigFailedDetails *ClusterConfigFailedEvent `json:"cluster_config_failed_details,omitempty"` // Placeholder for description of property cluster_leader_failover_details of obj type EventDetails field type str type object ClusterLeaderFailoverDetails *ClusterLeaderFailoverEvent `json:"cluster_leader_failover_details,omitempty"` // Placeholder for description of property cluster_node_add_details of obj type EventDetails field type str type object ClusterNodeAddDetails *ClusterNodeAddEvent `json:"cluster_node_add_details,omitempty"` // Placeholder for description of property cluster_node_db_failed_details of obj type EventDetails field type str type object ClusterNodeDbFailedDetails *ClusterNodeDbFailedEvent `json:"cluster_node_db_failed_details,omitempty"` // Placeholder for description of property cluster_node_remove_details of obj type EventDetails field type str type object ClusterNodeRemoveDetails *ClusterNodeRemoveEvent `json:"cluster_node_remove_details,omitempty"` // Placeholder for description of property cluster_node_shutdown_details of obj type EventDetails field type str type object ClusterNodeShutdownDetails *ClusterNodeShutdownEvent `json:"cluster_node_shutdown_details,omitempty"` // Placeholder for description of property cluster_node_started_details of obj type EventDetails field type str type object ClusterNodeStartedDetails *ClusterNodeStartedEvent `json:"cluster_node_started_details,omitempty"` // Placeholder for description of property cluster_service_critical_failure_details of obj type EventDetails field type str type object ClusterServiceCriticalFailureDetails *ClusterServiceCriticalFailureEvent `json:"cluster_service_critical_failure_details,omitempty"` // Placeholder for description of property cluster_service_failed_details of obj type EventDetails field type str type object ClusterServiceFailedDetails *ClusterServiceFailedEvent `json:"cluster_service_failed_details,omitempty"` // Placeholder for description of property cluster_service_restored_details of obj type EventDetails field type str type object ClusterServiceRestoredDetails *ClusterServiceRestoredEvent `json:"cluster_service_restored_details,omitempty"` // Placeholder for description of property cluster_warm_reboot_details of obj type EventDetails field type str type object ClusterWarmRebootDetails ClusterWarmRebootEvent `json:"cluster_warm_reboot_details,omitempty"` // Placeholder for description of property cntlr_host_list_details of obj type EventDetails field type str type object CntlrHostListDetails *VinfraCntlrHostUnreachableList `json:"cntlr_host_list_details,omitempty"` // Placeholder for description of property config_action_details of obj type EventDetails field type str type object ConfigActionDetails *ConfigActionDetails `json:"config_action_details,omitempty"` // Placeholder for description of property config_create_details of obj type EventDetails field type str type object ConfigCreateDetails *ConfigCreateDetails `json:"config_create_details,omitempty"` // Placeholder for description of property config_delete_details of obj type EventDetails field type str type object ConfigDeleteDetails *ConfigDeleteDetails `json:"config_delete_details,omitempty"` // Placeholder for description of property config_password_change_request_details of obj type EventDetails field type str type object ConfigPasswordChangeRequestDetails *ConfigUserPasswordChangeRequest `json:"config_password_change_request_details,omitempty"` // Placeholder for description of property config_se_grp_flv_update_details of obj type EventDetails field type str type object ConfigSeGrpFlvUpdateDetails *ConfigSeGrpFlvUpdate `json:"config_se_grp_flv_update_details,omitempty"` // Placeholder for description of property config_update_details of obj type EventDetails field type str type object ConfigUpdateDetails *ConfigUpdateDetails `json:"config_update_details,omitempty"` // Placeholder for description of property config_user_authrz_rule_details of obj type EventDetails field type str type object ConfigUserAuthrzRuleDetails *ConfigUserAuthrzByRule `json:"config_user_authrz_rule_details,omitempty"` // Placeholder for description of property config_user_login_details of obj type EventDetails field type str type object ConfigUserLoginDetails *ConfigUserLogin `json:"config_user_login_details,omitempty"` // Placeholder for description of property config_user_logout_details of obj type EventDetails field type str type object ConfigUserLogoutDetails *ConfigUserLogout `json:"config_user_logout_details,omitempty"` // Placeholder for description of property config_user_not_authrz_rule_details of obj type EventDetails field type str type object ConfigUserNotAuthrzRuleDetails *ConfigUserNotAuthrzByRule `json:"config_user_not_authrz_rule_details,omitempty"` // Placeholder for description of property container_cloud_batch_setup of obj type EventDetails field type str type object ContainerCloudBatchSetup *ContainerCloudBatchSetup `json:"container_cloud_batch_setup,omitempty"` // Placeholder for description of property container_cloud_setup of obj type EventDetails field type str type object ContainerCloudSetup *ContainerCloudSetup `json:"container_cloud_setup,omitempty"` // Placeholder for description of property container_cloud_sevice of obj type EventDetails field type str type object ContainerCloudSevice *ContainerCloudService `json:"container_cloud_sevice,omitempty"` // Field introduced in 20.1.4. ControllerDiscontinuousTimeChangeEventDetails *ControllerDiscontinuousTimeChangeEventDetails `json:"controller_discontinuous_time_change_event_details,omitempty"` // Placeholder for description of property controller_license_reconcile_details of obj type EventDetails field type str type object ControllerLicenseReconcileDetails *ControllerLicenseReconcileDetails `json:"controller_license_reconcile_details,omitempty"` // Placeholder for description of property crs_deployment_failure of obj type EventDetails field type str type object CrsDeploymentFailure *CRSDeploymentFailure `json:"crs_deployment_failure,omitempty"` // Placeholder for description of property crs_deployment_success of obj type EventDetails field type str type object CrsDeploymentSuccess *CRSDeploymentSuccess `json:"crs_deployment_success,omitempty"` // Placeholder for description of property crs_details of obj type EventDetails field type str type object CrsDetails *CRSDetails `json:"crs_details,omitempty"` // Placeholder for description of property crs_update_details of obj type EventDetails field type str type object CrsUpdateDetails *CRSUpdateDetails `json:"crs_update_details,omitempty"` // Placeholder for description of property cs_infra_details of obj type EventDetails field type str type object CsInfraDetails *CloudStackSetup `json:"cs_infra_details,omitempty"` // Database error event. Field introduced in 21.1.1. DatabaseEventInfo *DatabaseEventInfo `json:"database_event_info,omitempty"` // Placeholder for description of property delete_se_details of obj type EventDetails field type str type object DeleteSeDetails *RmDeleteSeEventDetails `json:"delete_se_details,omitempty"` // Placeholder for description of property disable_se_migrate_details of obj type EventDetails field type str type object DisableSeMigrateDetails *DisableSeMigrateEventDetails `json:"disable_se_migrate_details,omitempty"` // Placeholder for description of property disc_summary of obj type EventDetails field type str type object DiscSummary *VinfraDiscSummaryDetails `json:"disc_summary,omitempty"` // Placeholder for description of property dns_sync_info of obj type EventDetails field type str type object DNSSyncInfo *DNSVsSyncInfo `json:"dns_sync_info,omitempty"` // Placeholder for description of property docker_ucp_details of obj type EventDetails field type str type object DockerUcpDetails *DockerUCPSetup `json:"docker_ucp_details,omitempty"` // Placeholder for description of property dos_attack_event_details of obj type EventDetails field type str type object DosAttackEventDetails *DosAttackEventDetails `json:"dos_attack_event_details,omitempty"` // Placeholder for description of property gcp_cloud_router_info of obj type EventDetails field type str type object GcpCloudRouterInfo *GCPCloudRouterUpdate `json:"gcp_cloud_router_info,omitempty"` // Placeholder for description of property gcp_info of obj type EventDetails field type str type object GcpInfo *GCPSetup `json:"gcp_info,omitempty"` // Placeholder for description of property generic_audit_compliance_event_info of obj type EventDetails field type str type object GenericAuditComplianceEventInfo *AuditComplianceEventInfo `json:"generic_audit_compliance_event_info,omitempty"` // Placeholder for description of property glb_info of obj type EventDetails field type str type object GlbInfo *GslbStatus `json:"glb_info,omitempty"` // Placeholder for description of property gs_info of obj type EventDetails field type str type object GsInfo *GslbServiceStatus `json:"gs_info,omitempty"` HostUnavailDetails *HostUnavailEventDetails `json:"host_unavail_details,omitempty"` // Placeholder for description of property hs_details of obj type EventDetails field type str type object HsDetails *HealthScoreDetails `json:"hs_details,omitempty"` // Placeholder for description of property ip_fail_details of obj type EventDetails field type str type object IPFailDetails *RmSeIPFailEventDetails `json:"ip_fail_details,omitempty"` // Placeholder for description of property ip_threat_db_event_data of obj type EventDetails field type str type object IPThreatDbEventData *IPThreatDBEventData `json:"ip_threat_db_event_data,omitempty"` // Placeholder for description of property license_details of obj type EventDetails field type str type object LicenseDetails *LicenseDetails `json:"license_details,omitempty"` // Placeholder for description of property license_expiry_details of obj type EventDetails field type str type object LicenseExpiryDetails *LicenseExpiryDetails `json:"license_expiry_details,omitempty"` // Placeholder for description of property license_tier_switch_details of obj type EventDetails field type str type object LicenseTierSwitchDetails *LicenseTierSwitchDetiails `json:"license_tier_switch_details,omitempty"` // Placeholder for description of property license_transaction_details of obj type EventDetails field type str type object LicenseTransactionDetails *LicenseTransactionDetails `json:"license_transaction_details,omitempty"` // Placeholder for description of property log_agent_event_details of obj type EventDetails field type str type object LogAgentEventDetails *LogAgentEventDetail `json:"log_agent_event_details,omitempty"` // Placeholder for description of property marathon_service_port_conflict_details of obj type EventDetails field type str type object MarathonServicePortConflictDetails *MarathonServicePortConflict `json:"marathon_service_port_conflict_details,omitempty"` // Placeholder for description of property memory_balancer_info of obj type EventDetails field type str type object MemoryBalancerInfo *MemoryBalancerInfo `json:"memory_balancer_info,omitempty"` // Placeholder for description of property mesos_infra_details of obj type EventDetails field type str type object MesosInfraDetails *MesosSetup `json:"mesos_infra_details,omitempty"` // Placeholder for description of property metric_threshold_up_details of obj type EventDetails field type str type object MetricThresholdUpDetails *MetricThresoldUpDetails `json:"metric_threshold_up_details,omitempty"` // Placeholder for description of property metrics_db_disk_details of obj type EventDetails field type str type object MetricsDbDiskDetails *MetricsDbDiskEventDetails `json:"metrics_db_disk_details,omitempty"` // Placeholder for description of property metrics_db_queue_full_details of obj type EventDetails field type str type object MetricsDbQueueFullDetails *MetricsDbQueueFullEventDetails `json:"metrics_db_queue_full_details,omitempty"` // Placeholder for description of property metrics_db_queue_healthy_details of obj type EventDetails field type str type object MetricsDbQueueHealthyDetails *MetricsDbQueueHealthyEventDetails `json:"metrics_db_queue_healthy_details,omitempty"` // Placeholder for description of property mgmt_nw_change_details of obj type EventDetails field type str type object MgmtNwChangeDetails *VinfraMgmtNwChangeDetails `json:"mgmt_nw_change_details,omitempty"` // Placeholder for description of property modify_networks_details of obj type EventDetails field type str type object ModifyNetworksDetails *RmModifyNetworksEventDetails `json:"modify_networks_details,omitempty"` // Placeholder for description of property network_subnet_details of obj type EventDetails field type str type object NetworkSubnetDetails *NetworkSubnetInfo `json:"network_subnet_details,omitempty"` // Nsxt Image event. Field introduced in 20.1.1. NsxtImgDetails *NsxtImageDetails `json:"nsxt_img_details,omitempty"` // Nsxt cloud event. Field introduced in 20.1.1. NsxtInfo *NsxtSetup `json:"nsxt_info,omitempty"` // Placeholder for description of property nw_subnet_clash_details of obj type EventDetails field type str type object NwSubnetClashDetails *NetworkSubnetClash `json:"nw_subnet_clash_details,omitempty"` // Placeholder for description of property nw_summarized_details of obj type EventDetails field type str type object NwSummarizedDetails *SummarizedInfo `json:"nw_summarized_details,omitempty"` // Placeholder for description of property oci_info of obj type EventDetails field type str type object OciInfo *OCISetup `json:"oci_info,omitempty"` // Field introduced in 20.1.1. OsAPIVerCheckFailure *OpenStackAPIVersionCheckFailure `json:"os_api_ver_check_failure,omitempty"` // Placeholder for description of property os_infra_details of obj type EventDetails field type str type object OsInfraDetails *OpenStackClusterSetup `json:"os_infra_details,omitempty"` // Placeholder for description of property os_ip_details of obj type EventDetails field type str type object OsIPDetails *OpenStackIPChange `json:"os_ip_details,omitempty"` // Placeholder for description of property os_lbaudit_details of obj type EventDetails field type str type object OsLbauditDetails *OpenStackLbProvAuditCheck `json:"os_lbaudit_details,omitempty"` // Placeholder for description of property os_lbplugin_op_details of obj type EventDetails field type str type object OsLbpluginOpDetails *OpenStackLbPluginOp `json:"os_lbplugin_op_details,omitempty"` // Placeholder for description of property os_se_vm_details of obj type EventDetails field type str type object OsSeVMDetails *OpenStackSeVMChange `json:"os_se_vm_details,omitempty"` // Placeholder for description of property os_sync_services_details of obj type EventDetails field type str type object OsSyncServicesDetails *OpenStackSyncServices `json:"os_sync_services_details,omitempty"` // Placeholder for description of property os_vnic_details of obj type EventDetails field type str type object OsVnicDetails *OpenStackVnicChange `json:"os_vnic_details,omitempty"` // Placeholder for description of property pool_deployment_failure_info of obj type EventDetails field type str type object PoolDeploymentFailureInfo *PoolDeploymentFailureInfo `json:"pool_deployment_failure_info,omitempty"` // Placeholder for description of property pool_deployment_success_info of obj type EventDetails field type str type object PoolDeploymentSuccessInfo *PoolDeploymentSuccessInfo `json:"pool_deployment_success_info,omitempty"` // Placeholder for description of property pool_deployment_update_info of obj type EventDetails field type str type object PoolDeploymentUpdateInfo *PoolDeploymentUpdateInfo `json:"pool_deployment_update_info,omitempty"` // Placeholder for description of property pool_server_delete_details of obj type EventDetails field type str type object PoolServerDeleteDetails *VinfraPoolServerDeleteDetails `json:"pool_server_delete_details,omitempty"` // Placeholder for description of property psm_program_details of obj type EventDetails field type str type object PsmProgramDetails *PsmProgramDetails `json:"psm_program_details,omitempty"` // Field introduced in 20.1.1. RateLimiterEventDetails *RateLimiterEventDetails `json:"rate_limiter_event_details,omitempty"` // Placeholder for description of property rebalance_migrate_details of obj type EventDetails field type str type object RebalanceMigrateDetails *RebalanceMigrateEventDetails `json:"rebalance_migrate_details,omitempty"` // Placeholder for description of property rebalance_scalein_details of obj type EventDetails field type str type object RebalanceScaleinDetails *RebalanceScaleinEventDetails `json:"rebalance_scalein_details,omitempty"` // Placeholder for description of property rebalance_scaleout_details of obj type EventDetails field type str type object RebalanceScaleoutDetails *RebalanceScaleoutEventDetails `json:"rebalance_scaleout_details,omitempty"` // Placeholder for description of property reboot_se_details of obj type EventDetails field type str type object RebootSeDetails *RmRebootSeEventDetails `json:"reboot_se_details,omitempty"` // Placeholder for description of property scheduler_action_info of obj type EventDetails field type str type object SchedulerActionInfo *SchedulerActionDetails `json:"scheduler_action_info,omitempty"` // Field introduced in 20.1.1. SeBgpPeerDownDetails *SeBgpPeerDownDetails `json:"se_bgp_peer_down_details,omitempty"` // Placeholder for description of property se_bgp_peer_state_change_details of obj type EventDetails field type str type object SeBgpPeerStateChangeDetails *SeBgpPeerStateChangeDetails `json:"se_bgp_peer_state_change_details,omitempty"` // Placeholder for description of property se_details of obj type EventDetails field type str type object SeDetails *SeMgrEventDetails `json:"se_details,omitempty"` // Field introduced in 20.1.4. SeDiscontinuousTimeChangeEventDetails *SeDiscontinuousTimeChangeEventDetails `json:"se_discontinuous_time_change_event_details,omitempty"` // Placeholder for description of property se_dupip_event_details of obj type EventDetails field type str type object SeDupipEventDetails *SeDupipEventDetails `json:"se_dupip_event_details,omitempty"` // Placeholder for description of property se_gateway_heartbeat_failed_details of obj type EventDetails field type str type object SeGatewayHeartbeatFailedDetails *SeGatewayHeartbeatFailedDetails `json:"se_gateway_heartbeat_failed_details,omitempty"` // Placeholder for description of property se_gateway_heartbeat_success_details of obj type EventDetails field type str type object SeGatewayHeartbeatSuccessDetails *SeGatewayHeartbeatSuccessDetails `json:"se_gateway_heartbeat_success_details,omitempty"` // Placeholder for description of property se_geo_db_details of obj type EventDetails field type str type object SeGeoDbDetails *SeGeoDbDetails `json:"se_geo_db_details,omitempty"` // Placeholder for description of property se_hb_event_details of obj type EventDetails field type str type object SeHbEventDetails *SeHBEventDetails `json:"se_hb_event_details,omitempty"` // Inter-SE datapath heartbeat recovered. One event is generated when heartbeat recovers. Field introduced in 20.1.1. SeHbRecoveredEventDetails *SeHbRecoveredEventDetails `json:"se_hb_recovered_event_details,omitempty"` // Placeholder for description of property se_hm_gs_details of obj type EventDetails field type str type object SeHmGsDetails *SeHmEventGSDetails `json:"se_hm_gs_details,omitempty"` // Placeholder for description of property se_hm_gsgroup_details of obj type EventDetails field type str type object SeHmGsgroupDetails *SeHmEventGslbPoolDetails `json:"se_hm_gsgroup_details,omitempty"` // Placeholder for description of property se_hm_pool_details of obj type EventDetails field type str type object SeHmPoolDetails *SeHmEventPoolDetails `json:"se_hm_pool_details,omitempty"` // Placeholder for description of property se_hm_vs_details of obj type EventDetails field type str type object SeHmVsDetails *SeHmEventVsDetails `json:"se_hm_vs_details,omitempty"` // Placeholder for description of property se_ip6_dad_failed_event_details of obj type EventDetails field type str type object SeIp6DadFailedEventDetails *SeIp6DadFailedEventDetails `json:"se_ip6_dad_failed_event_details,omitempty"` // Placeholder for description of property se_ip_added_event_details of obj type EventDetails field type str type object SeIPAddedEventDetails *SeIPAddedEventDetails `json:"se_ip_added_event_details,omitempty"` // Placeholder for description of property se_ip_removed_event_details of obj type EventDetails field type str type object SeIPRemovedEventDetails *SeIPRemovedEventDetails `json:"se_ip_removed_event_details,omitempty"` // Placeholder for description of property se_ipfailure_event_details of obj type EventDetails field type str type object SeIpfailureEventDetails *SeIpfailureEventDetails `json:"se_ipfailure_event_details,omitempty"` // Placeholder for description of property se_licensed_bandwdith_exceeded_event_details of obj type EventDetails field type str type object SeLicensedBandwdithExceededEventDetails *SeLicensedBandwdithExceededEventDetails `json:"se_licensed_bandwdith_exceeded_event_details,omitempty"` // Field introduced in 18.2.2. SeMemoryLimitEventDetails *SeMemoryLimitEventDetails `json:"se_memory_limit_event_details,omitempty"` // Placeholder for description of property se_persistence_details of obj type EventDetails field type str type object SePersistenceDetails *SePersistenceEventDetails `json:"se_persistence_details,omitempty"` // Placeholder for description of property se_pool_lb_details of obj type EventDetails field type str type object SePoolLbDetails *SePoolLbEventDetails `json:"se_pool_lb_details,omitempty"` // Placeholder for description of property se_reconcile_details of obj type EventDetails field type str type object SeReconcileDetails *SeReconcileDetails `json:"se_reconcile_details,omitempty"` // Placeholder for description of property se_thresh_event_details of obj type EventDetails field type str type object SeThreshEventDetails *SeThreshEventDetails `json:"se_thresh_event_details,omitempty"` // Placeholder for description of property se_vnic_down_event_details of obj type EventDetails field type str type object SeVnicDownEventDetails *SeVnicDownEventDetails `json:"se_vnic_down_event_details,omitempty"` // Placeholder for description of property se_vnic_tx_queue_stall_event_details of obj type EventDetails field type str type object SeVnicTxQueueStallEventDetails *SeVnicTxQueueStallEventDetails `json:"se_vnic_tx_queue_stall_event_details,omitempty"` // Placeholder for description of property se_vnic_up_event_details of obj type EventDetails field type str type object SeVnicUpEventDetails *SeVnicUpEventDetails `json:"se_vnic_up_event_details,omitempty"` // Placeholder for description of property se_vs_fault_event_details of obj type EventDetails field type str type object SeVsFaultEventDetails *SeVsFaultEventDetails `json:"se_vs_fault_event_details,omitempty"` // Field introduced in 18.2.11,20.1.3. SeVsPktBufHighEventDetails *SeVsPktBufHighEventDetails `json:"se_vs_pkt_buf_high_event_details,omitempty"` // Placeholder for description of property sec_mgr_data_event of obj type EventDetails field type str type object SecMgrDataEvent *SecMgrDataEvent `json:"sec_mgr_data_event,omitempty"` // Placeholder for description of property secure_key_exchange_info of obj type EventDetails field type str type object SecureKeyExchangeInfo *SecureKeyExchangeDetails `json:"secure_key_exchange_info,omitempty"` // Placeholder for description of property semigrate_event_details of obj type EventDetails field type str type object SemigrateEventDetails *SeMigrateEventDetails `json:"semigrate_event_details,omitempty"` // Placeholder for description of property server_autoscale_failed_info of obj type EventDetails field type str type object ServerAutoscaleFailedInfo *ServerAutoScaleFailedInfo `json:"server_autoscale_failed_info,omitempty"` // Placeholder for description of property server_autoscalein_complete_info of obj type EventDetails field type str type object ServerAutoscaleinCompleteInfo *ServerAutoScaleInCompleteInfo `json:"server_autoscalein_complete_info,omitempty"` // Placeholder for description of property server_autoscalein_info of obj type EventDetails field type str type object ServerAutoscaleinInfo *ServerAutoScaleInInfo `json:"server_autoscalein_info,omitempty"` // Placeholder for description of property server_autoscaleout_complete_info of obj type EventDetails field type str type object ServerAutoscaleoutCompleteInfo *ServerAutoScaleOutCompleteInfo `json:"server_autoscaleout_complete_info,omitempty"` // Placeholder for description of property server_autoscaleout_info of obj type EventDetails field type str type object ServerAutoscaleoutInfo *ServerAutoScaleOutInfo `json:"server_autoscaleout_info,omitempty"` // Placeholder for description of property seupgrade_disrupted_details of obj type EventDetails field type str type object SeupgradeDisruptedDetails *SeUpgradeVsDisruptedEventDetails `json:"seupgrade_disrupted_details,omitempty"` // Placeholder for description of property seupgrade_event_details of obj type EventDetails field type str type object SeupgradeEventDetails *SeUpgradeEventDetails `json:"seupgrade_event_details,omitempty"` // Placeholder for description of property seupgrade_migrate_details of obj type EventDetails field type str type object SeupgradeMigrateDetails *SeUpgradeMigrateEventDetails `json:"seupgrade_migrate_details,omitempty"` // Placeholder for description of property seupgrade_scalein_details of obj type EventDetails field type str type object SeupgradeScaleinDetails *SeUpgradeScaleinEventDetails `json:"seupgrade_scalein_details,omitempty"` // Placeholder for description of property seupgrade_scaleout_details of obj type EventDetails field type str type object SeupgradeScaleoutDetails *SeUpgradeScaleoutEventDetails `json:"seupgrade_scaleout_details,omitempty"` // Placeholder for description of property spawn_se_details of obj type EventDetails field type str type object SpawnSeDetails *RmSpawnSeEventDetails `json:"spawn_se_details,omitempty"` // Placeholder for description of property ssl_expire_details of obj type EventDetails field type str type object SslExpireDetails *SSLExpireDetails `json:"ssl_expire_details,omitempty"` // Placeholder for description of property ssl_export_details of obj type EventDetails field type str type object SslExportDetails *SSLExportDetails `json:"ssl_export_details,omitempty"` // Placeholder for description of property ssl_ignored_details of obj type EventDetails field type str type object SslIgnoredDetails *SSLIgnoredDetails `json:"ssl_ignored_details,omitempty"` // Placeholder for description of property ssl_renew_details of obj type EventDetails field type str type object SslRenewDetails *SSLRenewDetails `json:"ssl_renew_details,omitempty"` // Placeholder for description of property ssl_renew_failed_details of obj type EventDetails field type str type object SslRenewFailedDetails *SSLRenewFailedDetails `json:"ssl_renew_failed_details,omitempty"` // Placeholder for description of property ssl_revoked_details of obj type EventDetails field type str type object SslRevokedDetails *SSLRevokedDetails `json:"ssl_revoked_details,omitempty"` // Placeholder for description of property switchover_details of obj type EventDetails field type str type object SwitchoverDetails *SwitchoverEventDetails `json:"switchover_details,omitempty"` // Placeholder for description of property switchover_fail_details of obj type EventDetails field type str type object SwitchoverFailDetails *SwitchoverFailEventDetails `json:"switchover_fail_details,omitempty"` // Azure cloud sync services event details. Field introduced in 18.2.3. SyncServicesInfo *CloudSyncServices `json:"sync_services_info,omitempty"` // Placeholder for description of property tencent_info of obj type EventDetails field type str type object TencentInfo *TencentSetup `json:"tencent_info,omitempty"` // Placeholder for description of property unbind_vs_se_details of obj type EventDetails field type str type object UnbindVsSeDetails *RmUnbindVsSeEventDetails `json:"unbind_vs_se_details,omitempty"` // Field introduced in 18.2.6. UpgradeEntry *UpgradeOpsEntry `json:"upgrade_entry,omitempty"` // Field introduced in 18.2.6. UpgradeStatusInfo *UpgradeStatusInfo `json:"upgrade_status_info,omitempty"` // Placeholder for description of property vca_infra_details of obj type EventDetails field type str type object VcaInfraDetails *VCASetup `json:"vca_infra_details,omitempty"` // Placeholder for description of property vcenter_connectivity_status of obj type EventDetails field type str type object VcenterConnectivityStatus *VinfraVcenterConnectivityStatus `json:"vcenter_connectivity_status,omitempty"` // Placeholder for description of property vcenter_details of obj type EventDetails field type str type object VcenterDetails *VinfraVcenterBadCredentials `json:"vcenter_details,omitempty"` // Placeholder for description of property vcenter_disc_failure of obj type EventDetails field type str type object VcenterDiscFailure *VinfraVcenterDiscoveryFailure `json:"vcenter_disc_failure,omitempty"` // Placeholder for description of property vcenter_network_limit of obj type EventDetails field type str type object VcenterNetworkLimit *VinfraVcenterNetworkLimit `json:"vcenter_network_limit,omitempty"` // Placeholder for description of property vcenter_obj_delete_details of obj type EventDetails field type str type object VcenterObjDeleteDetails *VinfraVcenterObjDeleteDetails `json:"vcenter_obj_delete_details,omitempty"` // Placeholder for description of property vip_autoscale of obj type EventDetails field type str type object VipAutoscale *VipScaleDetails `json:"vip_autoscale,omitempty"` // Placeholder for description of property vip_dns_info of obj type EventDetails field type str type object VipDNSInfo *DNSRegisterInfo `json:"vip_dns_info,omitempty"` // Placeholder for description of property vm_details of obj type EventDetails field type str type object VMDetails *VinfraVMDetails `json:"vm_details,omitempty"` // Placeholder for description of property vs_awaitingse_details of obj type EventDetails field type str type object VsAwaitingseDetails *VsAwaitingSeEventDetails `json:"vs_awaitingse_details,omitempty"` // Placeholder for description of property vs_error_details of obj type EventDetails field type str type object VsErrorDetails *VsErrorEventDetails `json:"vs_error_details,omitempty"` // Placeholder for description of property vs_fsm_details of obj type EventDetails field type str type object VsFsmDetails *VsFsmEventDetails `json:"vs_fsm_details,omitempty"` // Placeholder for description of property vs_initialplacement_details of obj type EventDetails field type str type object VsInitialplacementDetails *VsInitialPlacementEventDetails `json:"vs_initialplacement_details,omitempty"` // Placeholder for description of property vs_migrate_details of obj type EventDetails field type str type object VsMigrateDetails *VsMigrateEventDetails `json:"vs_migrate_details,omitempty"` // Placeholder for description of property vs_pool_nw_fltr_details of obj type EventDetails field type str type object VsPoolNwFltrDetails *VsPoolNwFilterEventDetails `json:"vs_pool_nw_fltr_details,omitempty"` // Placeholder for description of property vs_scalein_details of obj type EventDetails field type str type object VsScaleinDetails *VsScaleInEventDetails `json:"vs_scalein_details,omitempty"` // Placeholder for description of property vs_scaleout_details of obj type EventDetails field type str type object VsScaleoutDetails *VsScaleOutEventDetails `json:"vs_scaleout_details,omitempty"` }
EventDetails event details swagger:model EventDetails
type EventDetailsFilter ¶
type EventDetailsFilter struct { // Enum options - ALERT_OP_LT, ALERT_OP_LE, ALERT_OP_EQ, ALERT_OP_NE, ALERT_OP_GE, ALERT_OP_GT. // Required: true Comparator *string `json:"comparator"` // event_details_key of EventDetailsFilter. // Required: true EventDetailsKey *string `json:"event_details_key"` // event_details_value of EventDetailsFilter. // Required: true EventDetailsValue *string `json:"event_details_value"` }
EventDetailsFilter event details filter swagger:model EventDetailsFilter
type EventGenParams ¶
type EventGenParams struct { // cluster of EventGenParams. Cluster *string `json:"cluster,omitempty"` // Enum options - VINFRA_DISC_DC. VINFRA_DISC_HOST. VINFRA_DISC_CLUSTER. VINFRA_DISC_VM. VINFRA_DISC_NW. MGMT_NW_NAME_CHANGED. DISCOVERY_DATACENTER_DEL. VM_ADDED. VM_REMOVED. VINFRA_DISC_COMPLETE. VCENTER_ADDRESS_ERROR. SE_GROUP_CLUSTER_DEL. SE_GROUP_MGMT_NW_DEL. MGMT_NW_DEL. VCENTER_BAD_CREDENTIALS. ESX_HOST_UNREACHABLE. SERVER_DELETED. SE_GROUP_HOST_DEL. VINFRA_DISC_FAILURE. ESX_HOST_POWERED_DOWN... Events []string `json:"events,omitempty"` // pool of EventGenParams. Pool *string `json:"pool,omitempty"` // sslkeyandcertificate of EventGenParams. Sslkeyandcertificate *string `json:"sslkeyandcertificate,omitempty"` // virtualservice of EventGenParams. Virtualservice *string `json:"virtualservice,omitempty"` }
EventGenParams event gen params swagger:model EventGenParams
type EventLog ¶
type EventLog struct { // Enum options - EVENT_CONTEXT_SYSTEM, EVENT_CONTEXT_CONFIG, EVENT_CONTEXT_APP, EVENT_CONTEXT_ALL. Context *string `json:"context,omitempty"` // Summary of event details. DetailsSummary *string `json:"details_summary,omitempty"` // Event Description for each Event in the table view. EventDescription *string `json:"event_description,omitempty"` // Placeholder for description of property event_details of obj type EventLog field type str type object EventDetails *EventDetails `json:"event_details,omitempty"` // Enum options - VINFRA_DISC_DC. VINFRA_DISC_HOST. VINFRA_DISC_CLUSTER. VINFRA_DISC_VM. VINFRA_DISC_NW. MGMT_NW_NAME_CHANGED. DISCOVERY_DATACENTER_DEL. VM_ADDED. VM_REMOVED. VINFRA_DISC_COMPLETE. VCENTER_ADDRESS_ERROR. SE_GROUP_CLUSTER_DEL. SE_GROUP_MGMT_NW_DEL. MGMT_NW_DEL. VCENTER_BAD_CREDENTIALS. ESX_HOST_UNREACHABLE. SERVER_DELETED. SE_GROUP_HOST_DEL. VINFRA_DISC_FAILURE. ESX_HOST_POWERED_DOWN... // Required: true EventID *string `json:"event_id"` // Pages in which event should come up. EventPages []string `json:"event_pages,omitempty"` // Placeholder for description of property ignore_event_details_display of obj type EventLog field type str type boolean IgnoreEventDetailsDisplay *bool `json:"ignore_event_details_display,omitempty"` // Enum options - EVENT_INTERNAL, EVENT_EXTERNAL. Internal *string `json:"internal,omitempty"` // Placeholder for description of property is_security_event of obj type EventLog field type str type boolean IsSecurityEvent *bool `json:"is_security_event,omitempty"` // Enum options - UNKNOWN. VSMGR. SEMGR. RESMGR. VIMGR. METRICSMGR. CONFIG. SE_GENERAL. SE_FLOWTABLE. SE_HM. SE_POOL_PERSISTENCE. SE_POOL. VSERVER. CLOUD_CONNECTOR. CLUSTERMGR. HSMGR. NW_MGR. LICENSE_MGR. RES_MONITOR. STATEDBCACHE... // Required: true Module *string `json:"module"` // obj_name of EventLog. ObjName *string `json:"obj_name,omitempty"` // Enum options - VIRTUALSERVICE. POOL. HEALTHMONITOR. NETWORKPROFILE. APPLICATIONPROFILE. HTTPPOLICYSET. DNSPOLICY. SECURITYPOLICY. IPADDRGROUP. STRINGGROUP. SSLPROFILE. SSLKEYANDCERTIFICATE. NETWORKSECURITYPOLICY. APPLICATIONPERSISTENCEPROFILE. ANALYTICSPROFILE. VSDATASCRIPTSET. TENANT. PKIPROFILE. AUTHPROFILE. CLOUD... ObjType *string `json:"obj_type,omitempty"` // Unique object identifier of obj. ObjUUID *string `json:"obj_uuid,omitempty"` // Reason code for generating the event. This would be added to the alert where it would say alert generated on event with reason <reason code>. Enum options - SYSERR_SUCCESS, SYSERR_FAILURE, SYSERR_OUT_OF_MEMORY, SYSERR_NO_ENT, SYSERR_INVAL, SYSERR_ACCESS, SYSERR_FAULT, SYSERR_IO, SYSERR_TIMEOUT, SYSERR_NOT_SUPPORTED, SYSERR_NOT_READY, SYSERR_UPGRADE_IN_PROGRESS, SYSERR_WARM_START_IN_PROGRESS, SYSERR_TRY_AGAIN, SYSERR_NOT_UPGRADING, SYSERR_PENDING, SYSERR_EVENT_GEN_FAILURE, SYSERR_CONFIG_PARAM_MISSING, SYSERR_RANGE, SYSERR_BAD_REQUEST... ReasonCode *string `json:"reason_code,omitempty"` // related objects corresponding to the events. RelatedUuids []string `json:"related_uuids,omitempty"` // Number of report_timestamp. // Required: true ReportTimestamp *int64 `json:"report_timestamp"` // tenant of EventLog. Tenant *string `json:"tenant,omitempty"` // Field introduced in 17.2.1. TenantName *string `json:"tenant_name,omitempty"` }
EventLog event log swagger:model EventLog
type EventMap ¶
type EventMap struct { // List of all events node wise.(Not in use). Field introduced in 18.2.6. NodesEvents []*UpgradeEvent `json:"nodes_events,omitempty"` // List of all events node wise. Field introduced in 18.2.10, 20.1.1. SubEvents []*UpgradeEvent `json:"sub_events,omitempty"` // Enum representing the task.(Not in use). Enum options - PREPARE_FOR_SHUTDOWN, COPY_AND_VERIFY_IMAGE, INSTALL_IMAGE, POST_INSTALL_HOOKS, PREPARE_CONTROLLER_FOR_SHUTDOWN, STOP_CONTROLLER, EXTRACT_PATCH_IMAGE, EXECUTE_PRE_INSTALL_COMMANDS, INSTALL_PATCH_IMAGE, PREPARE_FOR_REBOOT_CONTROLLER_NODES, REBOOT_CONTROLLER_NODES, WAIT_FOR_ALL_CONTROLLER_NODES_ONLINE, PRE_UPGRADE_HOOKS, MIGRATE_CONFIG, START_PRIMARY_CONTROLLER, START_ALL_CONTROLLERS, POST_UPGRADE_HOOKS, EXECUTE_POST_INSTALL_COMMANDS, SET_CONTROLLER_UPGRADE_COMPLETED, STATE_NOT_USED_IN_V2.... Field introduced in 18.2.6. Task *string `json:"task,omitempty"` // Name representing the task. Field introduced in 18.2.10, 20.1.1. TaskName *string `json:"task_name,omitempty"` }
EventMap event map swagger:model EventMap
type FailAction ¶
type FailAction struct { // Backup Pool when pool experiences a failure. Field deprecated in 18.1.2. BackupPool *FailActionBackupPool `json:"backup_pool,omitempty"` // Local response to HTTP requests when pool experiences a failure. LocalRsp *FailActionHTTPLocalResponse `json:"local_rsp,omitempty"` // URL to redirect HTTP requests to when pool experiences a failure. Redirect *FailActionHTTPRedirect `json:"redirect,omitempty"` // Enables a response to client when pool experiences a failure. By default TCP connection is closed. Enum options - FAIL_ACTION_HTTP_REDIRECT, FAIL_ACTION_HTTP_LOCAL_RSP, FAIL_ACTION_CLOSE_CONN, FAIL_ACTION_BACKUP_POOL. Allowed in Basic(Allowed values- FAIL_ACTION_CLOSE_CONN) edition, Essentials(Allowed values- FAIL_ACTION_CLOSE_CONN) edition, Enterprise edition. // Required: true Type *string `json:"type"` }
FailAction fail action swagger:model FailAction
type FailActionBackupPool ¶
type FailActionBackupPool struct { // Specifies the UUID of the Pool acting as backup pool. It is a reference to an object of type Pool. // Required: true BackupPoolRef *string `json:"backup_pool_ref"` }
FailActionBackupPool fail action backup pool swagger:model FailActionBackupPool
type FailActionHTTPLocalResponse ¶
type FailActionHTTPLocalResponse struct { // Placeholder for description of property file of obj type FailActionHTTPLocalResponse field type str type object File *HTTPLocalFile `json:"file,omitempty"` // Enum options - FAIL_HTTP_STATUS_CODE_200, FAIL_HTTP_STATUS_CODE_503. StatusCode *string `json:"status_code,omitempty"` }
FailActionHTTPLocalResponse fail action HTTP local response swagger:model FailActionHTTPLocalResponse
type FailActionHTTPRedirect ¶
type FailActionHTTPRedirect struct { // host of FailActionHTTPRedirect. // Required: true Host *string `json:"host"` // path of FailActionHTTPRedirect. Path *string `json:"path,omitempty"` // Enum options - HTTP, HTTPS. Protocol *string `json:"protocol,omitempty"` // query of FailActionHTTPRedirect. Query *string `json:"query,omitempty"` // Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307. StatusCode *string `json:"status_code,omitempty"` }
FailActionHTTPRedirect fail action HTTP redirect swagger:model FailActionHTTPRedirect
type FeProxyRoutePublishConfig ¶
type FeProxyRoutePublishConfig struct { // Publish ECMP route to upstream router for VIP. Enum options - FE_PROXY_ROUTE_PUBLISH_NONE, FE_PROXY_ROUTE_PUBLISH_QUAGGA_WEBAPP. Mode *string `json:"mode,omitempty"` // Listener port for publisher. PublisherPort *int32 `json:"publisher_port,omitempty"` // Subnet for publisher. Subnet *int32 `json:"subnet,omitempty"` // Token for tracking changes. Token *string `json:"token,omitempty"` }
FeProxyRoutePublishConfig fe proxy route publish config swagger:model FeProxyRoutePublishConfig
type FederationCheckpoint ¶
type FederationCheckpoint struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Date when the checkpoint was created. Field introduced in 20.1.1. Date *string `json:"date,omitempty"` // Description for this checkpoint. Field introduced in 20.1.1. Description *string `json:"description,omitempty"` // This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 20.1.1. IsFederated *bool `json:"is_federated,omitempty"` // Name of the Checkpoint. Field introduced in 20.1.1. // Required: true Name *string `json:"name"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 20.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the Checkpoint. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` }
FederationCheckpoint federation checkpoint swagger:model FederationCheckpoint
type FederationCheckpointAPIResponse ¶
type FederationCheckpointAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*FederationCheckpoint `json:"results,omitempty"` }
FederationCheckpointAPIResponse federation checkpoint Api response swagger:model FederationCheckpointApiResponse
type FileObject ¶
type FileObject struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // SHA1 checksum of the file. Field introduced in 20.1.1. Checksum *string `json:"checksum,omitempty"` // This field indicates whether the file is gzip-compressed. Field introduced in 20.1.1. Compressed *bool `json:"compressed,omitempty"` // Timestamp of creation for the file. Field introduced in 20.1.1. Created *string `json:"created,omitempty"` // Description of the file. Field introduced in 20.1.1. Description *string `json:"description,omitempty"` // Timestamp when the file will be no longer needed and can be removed by the system. If this is set, a garbage collector process will try to remove the file after this time. Field introduced in 20.1.1. ExpiresAt *string `json:"expires_at,omitempty"` // This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 20.1.1. IsFederated *bool `json:"is_federated,omitempty"` // Name of the file object. Field introduced in 20.1.1. // Required: true Name *string `json:"name"` // Path to the file. Field introduced in 20.1.1. Path *string `json:"path,omitempty"` // Enforce Read-Only on the file. Field introduced in 20.1.1. ReadOnly *bool `json:"read_only,omitempty"` // Flag to allow/restrict download of the file. Field introduced in 20.1.1. RestrictDownload *bool `json:"restrict_download,omitempty"` // Size of the file. Field introduced in 20.1.1. Size *int64 `json:"size,omitempty"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 20.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // Type of the file. Enum options - OTHER_FILE_TYPES, IP_REPUTATION, GEO_DB, TECH_SUPPORT, HSMPACKAGES, IPAMDNSSCRIPTS, CONTROLLER_IMAGE. Field introduced in 20.1.1. Allowed in Basic(Allowed values- OTHER_FILE_TYPES) edition, Essentials(Allowed values- OTHER_FILE_TYPES) edition, Enterprise edition. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the file. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` // Version of the file. Field introduced in 20.1.1. Version *string `json:"version,omitempty"` }
FileObject file object swagger:model FileObject
type FileObjectAPIResponse ¶
type FileObjectAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*FileObject `json:"results,omitempty"` }
FileObjectAPIResponse file object Api response swagger:model FileObjectApiResponse
type FloatingIPSubnet ¶
type FloatingIPSubnet struct { // FloatingIp subnet name if available, else uuid. Field introduced in 17.2.1. // Required: true Name *string `json:"name"` // FloatingIp subnet prefix. Field introduced in 17.2.1. Prefix *IPAddrPrefix `json:"prefix,omitempty"` // FloatingIp subnet uuid. Field introduced in 17.2.1. UUID *string `json:"uuid,omitempty"` }
FloatingIPSubnet floating Ip subnet swagger:model FloatingIpSubnet
type FlowtableProfile ¶
type FlowtableProfile struct { // Idle timeout in seconds for ICMP flows. Allowed values are 1-36000. Field introduced in 20.1.3. Unit is SECONDS. IcmpIDLETimeout *int32 `json:"icmp_idle_timeout,omitempty"` // Idle timeout in seconds for TCP flows in closed state. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. TCPClosedTimeout *int32 `json:"tcp_closed_timeout,omitempty"` // Idle timeout in seconds for nat TCP flows in connection setup state. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. TCPConnectionSetupTimeout *int32 `json:"tcp_connection_setup_timeout,omitempty"` // Idle timeout in seconds for TCP flows in half closed state. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. TCPHalfClosedTimeout *int32 `json:"tcp_half_closed_timeout,omitempty"` // Idle timeout in seconds for TCP flows. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. TCPIDLETimeout *int32 `json:"tcp_idle_timeout,omitempty"` // Timeout in seconds for TCP flows after RST is seen.Within this timeout, if any non-syn packet is seenfrom the endpoint from which RST is received,nat-flow moves to established state. Otherwise nat-flowis cleaned up. This state helps to mitigate the impactof RST attacks. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. TCPResetTimeout *int32 `json:"tcp_reset_timeout,omitempty"` // Idle timeout in seconds for UDP flows. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. UDPIDLETimeout *int32 `json:"udp_idle_timeout,omitempty"` }
FlowtableProfile flowtable profile swagger:model FlowtableProfile
type FullClientLogs ¶
type FullClientLogs struct { // [DEPRECATED] Log all headers. Please use the all_headers flag in AnalyticsPolicy. Field deprecated in 18.1.4, 18.2.1. AllHeaders *bool `json:"all_headers,omitempty"` // How long should the system capture all logs, measured in minutes. Set to 0 for infinite. Special values are 0 - 'infinite'. Unit is MIN. Duration *int32 `json:"duration,omitempty"` // Capture all client logs including connections and requests. When deactivated, only errors will be logged. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is False. // Required: true Enabled *bool `json:"enabled"` // This setting limits the number of non-significant logs generated per second for this VS on each SE. Default is 10 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. Throttle *int32 `json:"throttle,omitempty"` }
FullClientLogs full client logs swagger:model FullClientLogs
type GCPCloudRouterUpdate ¶
type GCPCloudRouterUpdate struct { // Action performed Action can be either Route Added or Route Removed from Router. Field introduced in 18.2.5. Action *string `json:"action,omitempty"` // Cloud UUID. Field introduced in 18.2.5. CcID *string `json:"cc_id,omitempty"` // Reason for the failure. Field introduced in 18.2.5. ErrorString *string `json:"error_string,omitempty"` // Virtual Service Floating IP. Field introduced in 18.2.5. Fip *IPAddr `json:"fip,omitempty"` // GCP Cloud Router URL. Field introduced in 18.2.5. RouterURL *string `json:"router_url,omitempty"` // Virtual Service IP. Field introduced in 18.2.5. Vip *IPAddr `json:"vip,omitempty"` // Virtual Service UUID. Field introduced in 18.2.5. VsUUID *string `json:"vs_uuid,omitempty"` }
GCPCloudRouterUpdate g c p cloud router update swagger:model GCPCloudRouterUpdate
type GCPConfiguration ¶
type GCPConfiguration struct { // Credentials to access Google Cloud Platform APIs. It is a reference to an object of type CloudConnectorUser. Field introduced in 18.2.1. CloudCredentialsRef *string `json:"cloud_credentials_ref,omitempty"` // Deprecated, please use encryption_keys field. Field deprecated in 18.2.10, 20.1.2. Field introduced in 18.2.7, 20.1.1. EncryptionKeyID *string `json:"encryption_key_id,omitempty"` // Encryption Keys for Google Cloud Services. Field introduced in 18.2.10, 20.1.2. EncryptionKeys *GCPEncryptionKeys `json:"encryption_keys,omitempty"` // Firewall rule network target tags which will be applied on Service Engines to allow ingress and egress traffic for Service Engines. Field introduced in 18.2.1. FirewallTargetTags []string `json:"firewall_target_tags,omitempty"` // Google Cloud Storage Bucket Name where Service Engine image will be uploaded. This image will be deleted once the image is created in Google compute images. By default, a bucket will be created if this field is not specified. Field introduced in 18.2.1. GcsBucketName *string `json:"gcs_bucket_name,omitempty"` // Google Cloud Storage Project ID where Service Engine image will be uploaded. This image will be deleted once the image is created in Google compute images. By default, Service Engine Project ID will be used. Field introduced in 18.2.1. GcsProjectID *string `json:"gcs_project_id,omitempty"` // Deprecated, please use match_se_group_subnet in routes mode in . vip_allocation_strategy. Field deprecated in 20.1.1. Field introduced in 18.2.1. MatchSeGroupSubnet *bool `json:"match_se_group_subnet,omitempty"` // Google Cloud Platform VPC Network configuration for the Service Engines. Field introduced in 18.2.1. // Required: true NetworkConfig *GCPNetworkConfig `json:"network_config"` // Google Cloud Platform Region Name where Service Engines will be spawned. Field introduced in 18.2.1. // Required: true RegionName *string `json:"region_name"` // Google Cloud Platform Project ID where Service Engines will be spawned. Field introduced in 18.2.1. // Required: true SeProjectID *string `json:"se_project_id"` // VIP allocation strategy defines how the VIPs will be created in Google Cloud. Field introduced in 18.2.9, 20.1.1. // Required: true VipAllocationStrategy *GCPVIPAllocation `json:"vip_allocation_strategy"` // Google Cloud Platform Zones where Service Engines will be distributed for HA. Field introduced in 18.2.1. Minimum of 1 items required. // Required: true Zones []string `json:"zones,omitempty"` }
GCPConfiguration g c p configuration swagger:model GCPConfiguration
type GCPCredentials ¶
type GCPCredentials struct { // Google Cloud Platform Service Account keyfile data in JSON format. Field introduced in 18.2.1. ServiceAccountKeyfileData *string `json:"service_account_keyfile_data,omitempty"` }
GCPCredentials g c p credentials swagger:model GCPCredentials
type GCPEncryptionKeys ¶
type GCPEncryptionKeys struct { // CMEK Resource ID to encrypt Google Cloud Storage Bucket. This Bucket is used to upload Service Engine raw image. Field introduced in 18.2.10, 20.1.2. GcsBucketKmsKeyID *string `json:"gcs_bucket_kms_key_id,omitempty"` // CMEK Resource ID to encrypt Service Engine raw image. The raw image is a Google Cloud Storage Object. Field introduced in 18.2.10, 20.1.2. GcsObjectsKmsKeyID *string `json:"gcs_objects_kms_key_id,omitempty"` // CMEK Resource ID to encrypt Service Engine Disks. Field introduced in 18.2.10, 20.1.2. SeDiskKmsKeyID *string `json:"se_disk_kms_key_id,omitempty"` // CMEK Resource ID to encrypt Service Engine GCE Image. Field introduced in 18.2.10, 20.1.2. SeImageKmsKeyID *string `json:"se_image_kms_key_id,omitempty"` }
GCPEncryptionKeys g c p encryption keys swagger:model GCPEncryptionKeys
type GCPInBandManagement ¶
type GCPInBandManagement struct { // Service Engine Network Name. Field introduced in 18.2.2. // Required: true VpcNetworkName *string `json:"vpc_network_name"` // Project ID of the Service Engine Network. By default, Service Engine Project ID will be used. Field introduced in 18.2.1. VpcProjectID *string `json:"vpc_project_id,omitempty"` // Service Engine Network Subnet Name. Field introduced in 18.2.1. // Required: true VpcSubnetName *string `json:"vpc_subnet_name"` }
GCPInBandManagement g c p in band management swagger:model GCPInBandManagement
type GCPNetworkConfig ¶
type GCPNetworkConfig struct { // Config Mode for Google Cloud network configuration. Enum options - INBAND_MANAGEMENT, ONE_ARM_MODE, TWO_ARM_MODE. Field introduced in 18.2.1. // Required: true Config *string `json:"config"` // Configure InBand Management as Google Cloud network configuration. In this configuration the data network and management network for Service Engines will be same. Field introduced in 18.2.1. Inband *GCPInBandManagement `json:"inband,omitempty"` // Configure One Arm Mode as Google Cloud network configuration. In this configuration the data network and the management network for the Service Engines will be separated. Field introduced in 18.2.1. OneArm *GCPOneArmMode `json:"one_arm,omitempty"` // Configure Two Arm Mode as Google Cloud network configuration. In this configuration the frontend data network, backend data network and the management network for the Service Engines will be separated. Field introduced in 18.2.1. TwoArm *GCPTwoArmMode `json:"two_arm,omitempty"` }
GCPNetworkConfig g c p network config swagger:model GCPNetworkConfig
type GCPOneArmMode ¶
type GCPOneArmMode struct { // Service Engine Data Network Name. Field introduced in 18.2.2. // Required: true DataVpcNetworkName *string `json:"data_vpc_network_name"` // Project ID of the Service Engine Data Network. By default, Service Engine Project ID will be used. Field introduced in 18.2.1. DataVpcProjectID *string `json:"data_vpc_project_id,omitempty"` // Service Engine Data Network Subnet Name. Field introduced in 18.2.1. // Required: true DataVpcSubnetName *string `json:"data_vpc_subnet_name"` // Service Engine Management Network Name. Field introduced in 18.2.2. // Required: true ManagementVpcNetworkName *string `json:"management_vpc_network_name"` // Service Engine Management Network Subnet Name. Field introduced in 18.2.1. // Required: true ManagementVpcSubnetName *string `json:"management_vpc_subnet_name"` }
GCPOneArmMode g c p one arm mode swagger:model GCPOneArmMode
type GCPSeGroupConfig ¶
type GCPSeGroupConfig struct { // Service Engine Backend Data Network Name, used only for GCP cloud.Overrides the cloud level setting for Backend Data Network in GCP Two Arm Mode. Field introduced in 20.1.3. BackendDataVpcNetworkName *string `json:"backend_data_vpc_network_name,omitempty"` // Service Engine Backend Data Subnet Name, used only for GCP cloud.Overrides the cloud level setting for Backend Data Subnet in GCP Two Arm Mode. Field introduced in 20.1.3. BackendDataVpcSubnetName *string `json:"backend_data_vpc_subnet_name,omitempty"` }
GCPSeGroupConfig g c p se group config swagger:model GCPSeGroupConfig
type GCPSetup ¶
type GCPSetup struct { // cc_id of GCPSetup. CcID *string `json:"cc_id,omitempty"` // hostname of GCPSetup. Hostname *string `json:"hostname,omitempty"` // network of GCPSetup. Network *string `json:"network,omitempty"` // nhop_inst of GCPSetup. NhopInst *string `json:"nhop_inst,omitempty"` // Placeholder for description of property nhop_ip of obj type GCPSetup field type str type object NhopIP *IPAddr `json:"nhop_ip,omitempty"` // project of GCPSetup. Project *string `json:"project,omitempty"` // reason of GCPSetup. Reason *string `json:"reason,omitempty"` // route_name of GCPSetup. RouteName *string `json:"route_name,omitempty"` // subnet of GCPSetup. Subnet *string `json:"subnet,omitempty"` // Placeholder for description of property vip of obj type GCPSetup field type str type object Vip *IPAddr `json:"vip,omitempty"` // vs_name of GCPSetup. VsName *string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID *string `json:"vs_uuid,omitempty"` // zone of GCPSetup. Zone *string `json:"zone,omitempty"` }
GCPSetup g c p setup swagger:model GCPSetup
type GCPTwoArmMode ¶
type GCPTwoArmMode struct { // Service Engine Backend Data Network Name. Field introduced in 18.2.2. // Required: true BackendDataVpcNetworkName *string `json:"backend_data_vpc_network_name"` // Service Engine Backend Data Network Subnet Name. Field introduced in 18.2.1. // Required: true BackendDataVpcSubnetName *string `json:"backend_data_vpc_subnet_name"` // Service Engine Frontend Data Network Name. Field introduced in 18.2.2. // Required: true FrontendDataVpcNetworkName *string `json:"frontend_data_vpc_network_name"` // Project ID of the Service Engine Frontend Data Network. By default, Service Engine Project ID will be used. Field introduced in 18.2.1. FrontendDataVpcProjectID *string `json:"frontend_data_vpc_project_id,omitempty"` // Service Engine Frontend Data Network Subnet Name. Field introduced in 18.2.1. // Required: true FrontendDataVpcSubnetName *string `json:"frontend_data_vpc_subnet_name"` // Service Engine Management Network Name. Field introduced in 18.2.2. // Required: true ManagementVpcNetworkName *string `json:"management_vpc_network_name"` // Service Engine Management Network Subnet Name. Field introduced in 18.2.1. // Required: true ManagementVpcSubnetName *string `json:"management_vpc_subnet_name"` }
GCPTwoArmMode g c p two arm mode swagger:model GCPTwoArmMode
type GCPVIPAllocation ¶
type GCPVIPAllocation struct { // Configure Google Cloud Internal LoadBalancer for VIP. The VIP will be auto allocated from a Google Cloud VPC Subnet. Field introduced in 18.2.9, 20.1.1. Ilb *GCPVIPILB `json:"ilb,omitempty"` // VIP Allocation Mode. Enum options - ROUTES, ILB. Field introduced in 18.2.9, 20.1.1. // Required: true Mode *string `json:"mode"` // Configure Google Cloud VPC Routes for VIP. The VIP can either be a static IP or auto allocted from AVI Internal Network. The VIP should not overlap with any of the subnet ranges in Google Cloud VPC. Field introduced in 18.2.9, 20.1.1. Routes *GCPVIPRoutes `json:"routes,omitempty"` }
GCPVIPAllocation g c p v IP allocation swagger:model GCPVIPAllocation
type GCPVIPILB ¶
type GCPVIPILB struct { // Google Cloud Router Names to advertise BYOIP. Field introduced in 18.2.9, 20.1.1. CloudRouterNames []string `json:"cloud_router_names,omitempty"` }
GCPVIPILB g c p v IP i l b swagger:model GCPVIPILB
type GCPVIPRoutes ¶
type GCPVIPRoutes struct { // Match SE group subnets for VIP placement. Default is to not match SE group subnets. Field introduced in 18.2.9, 20.1.1. MatchSeGroupSubnet *bool `json:"match_se_group_subnet,omitempty"` }
GCPVIPRoutes g c p v IP routes swagger:model GCPVIPRoutes
type GatewayMonitor ¶
type GatewayMonitor struct { // IP address of next hop gateway to be monitored. // Required: true GatewayIP *IPAddr `json:"gateway_ip"` // The number of consecutive failed gateway health checks before a gateway is marked down. Allowed values are 3-50. GatewayMonitorFailThreshold *int32 `json:"gateway_monitor_fail_threshold,omitempty"` // The interval between two ping requests sent by the gateway monitor in milliseconds. If a value is not specified, requests are sent every second. Allowed values are 100-60000. Unit is MILLISECONDS. GatewayMonitorInterval *int32 `json:"gateway_monitor_interval,omitempty"` // The number of consecutive successful gateway health checks before a gateway that was marked down by the gateway monitor is marked up. Allowed values are 3-50. GatewayMonitorSuccessThreshold *int32 `json:"gateway_monitor_success_threshold,omitempty"` // Subnet providing reachability for Multi-hop Gateway. Field introduced in 18.1.1. Subnet *IPAddrPrefix `json:"subnet,omitempty"` }
GatewayMonitor gateway monitor swagger:model GatewayMonitor
type GcpInfo ¶
type GcpInfo struct { // Hostname of this SE. Hostname *string `json:"hostname,omitempty"` // Network this SE is assigned. // Required: true Network *string `json:"network"` // Project this SE belongs to. // Required: true Project *string `json:"project"` // Subnet assigned to this SE. Subnet *string `json:"subnet,omitempty"` // Zone this SE is part of. // Required: true Zone *string `json:"zone"` }
GcpInfo gcp info swagger:model GcpInfo
type GeoDB ¶
type GeoDB struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Description. Field introduced in 21.1.1. Description *string `json:"description,omitempty"` // Geo Database files. Field introduced in 21.1.1. // Required: true Files []*GeoDBFile `json:"files,omitempty"` // This field indicates that this object is replicated across GSLB federation. Field introduced in 21.1.1. IsFederated *bool `json:"is_federated,omitempty"` // Custom mappings of geo values. All mappings which start with the prefix 'System-' (any case) are reserved for system default objects and may be overwritten. Field introduced in 21.1.1. Mappings []*GeoDBMapping `json:"mappings,omitempty"` // Geo Database name. Field introduced in 21.1.1. // Required: true Name *string `json:"name"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 21.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of this object. Field introduced in 21.1.1. UUID *string `json:"uuid,omitempty"` }
GeoDB geo d b swagger:model GeoDB
type GeoDBAPIResponse ¶
type GeoDBAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*GeoDB `json:"results,omitempty"` }
GeoDBAPIResponse geo d b Api response swagger:model GeoDBApiResponse
type GeoDBFile ¶
type GeoDBFile struct { // If set to false, this file is ignored. Field introduced in 21.1.1. Enabled *bool `json:"enabled,omitempty"` // The file object that contains the geo data. Must be of type 'GeoDB'. It is a reference to an object of type FileObject. Field introduced in 21.1.1. // Required: true FileRef *string `json:"file_ref"` // Priority of the file. Field introduced in 21.1.1. // Required: true Index *int32 `json:"index"` // Name of the file. Field introduced in 21.1.1. // Required: true Name *string `json:"name"` // Source of the file data. Enum options - VENDOR_USER_DEFINED, VENDOR_AVI_DEFINED. Field introduced in 21.1.1. // Required: true Vendor *string `json:"vendor"` }
GeoDBFile geo d b file swagger:model GeoDBFile
type GeoDBMapping ¶
type GeoDBMapping struct { // Description of the mapping. Field introduced in 21.1.1. Description *string `json:"description,omitempty"` // The set of mapping elements. Field introduced in 21.1.1. // Required: true Elements []*GeoDBMappingElement `json:"elements,omitempty"` // The unique name of the user mapping. Field introduced in 21.1.1. // Required: true Name *string `json:"name"` }
GeoDBMapping geo d b mapping swagger:model GeoDBMapping
type GeoDBMappingElement ¶
type GeoDBMappingElement struct { // The attribute to map. Enum options - ATTRIBUTE_IP_PREFIX, ATTRIBUTE_COUNTRY_CODE, ATTRIBUTE_COUNTRY_NAME, ATTRIBUTE_CONTINENT_CODE, ATTRIBUTE_CONTINENT_NAME, ATTRIBUTE_REGION_NAME, ATTRIBUTE_CITY_NAME, ATTRIBUTE_ISP_NAME, ATTRIBUTE_ORGANIZATION_NAME, ATTRIBUTE_AS_NUMBER, ATTRIBUTE_AS_NAME, ATTRIBUTE_LONGITUDE, ATTRIBUTE_LATITUDE, ATTRIBUTE_CUSTOM_1, ATTRIBUTE_CUSTOM_2, ATTRIBUTE_CUSTOM_3, ATTRIBUTE_CUSTOM_4, ATTRIBUTE_CUSTOM_5, ATTRIBUTE_CUSTOM_6, ATTRIBUTE_CUSTOM_7.... Field introduced in 21.1.1. // Required: true Attribute *string `json:"attribute"` // The values to map. Field introduced in 21.1.1. // Required: true Values []string `json:"values,omitempty"` }
GeoDBMappingElement geo d b mapping element swagger:model GeoDBMappingElement
type GeoLocation ¶
type GeoLocation struct { // Latitude of the location. This is represented as degrees.minutes. The range is from -90.0 (south) to +90.0 (north). Allowed values are -90.0-+90.0. Field introduced in 17.1.1. Latitude *float32 `json:"latitude,omitempty"` // Longitude of the location. This is represented as degrees.minutes. The range is from -180.0 (west) to +180.0 (east). Allowed values are -180.0-+180.0. Field introduced in 17.1.1. Longitude *float32 `json:"longitude,omitempty"` // Location name in the format Country/State/City. Field introduced in 17.1.1. Name *string `json:"name,omitempty"` // Location tag *string - example USEast. Field introduced in 17.1.1. Tag *string `json:"tag,omitempty"` }
GeoLocation geo location swagger:model GeoLocation
type GeoMatch ¶
type GeoMatch struct { // The Geo data type to match on. Enum options - ATTRIBUTE_IP_PREFIX, ATTRIBUTE_COUNTRY_CODE, ATTRIBUTE_COUNTRY_NAME, ATTRIBUTE_CONTINENT_CODE, ATTRIBUTE_CONTINENT_NAME, ATTRIBUTE_REGION_NAME, ATTRIBUTE_CITY_NAME, ATTRIBUTE_ISP_NAME, ATTRIBUTE_ORGANIZATION_NAME, ATTRIBUTE_AS_NUMBER, ATTRIBUTE_AS_NAME, ATTRIBUTE_LONGITUDE, ATTRIBUTE_LATITUDE, ATTRIBUTE_CUSTOM_1, ATTRIBUTE_CUSTOM_2, ATTRIBUTE_CUSTOM_3, ATTRIBUTE_CUSTOM_4, ATTRIBUTE_CUSTOM_5, ATTRIBUTE_CUSTOM_6, ATTRIBUTE_CUSTOM_7.... Field introduced in 21.1.1. // Required: true Attribute *string `json:"attribute"` // Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. // Required: true MatchOperation *string `json:"match_operation"` // The values to match. Field introduced in 21.1.1. // Required: true Values []string `json:"values,omitempty"` }
GeoMatch geo match swagger:model GeoMatch
type Gslb ¶
type Gslb struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Frequency with which messages are propagated to Vs Mgr. Value of 0 disables async behavior and RPC are sent inline. Allowed values are 0-5. Field introduced in 18.2.3. Unit is SEC. AsyncInterval *int32 `json:"async_interval,omitempty"` // Max retries after which the remote site is treated as a fresh start. In fresh start all the configs are downloaded. Allowed values are 1-1024. ClearOnMaxRetries *int32 `json:"clear_on_max_retries,omitempty"` // Group to specify if the client ip addresses are public or private. Field introduced in 17.1.2. ClientIPAddrGroup *GslbClientIPAddrGroup `json:"client_ip_addr_group,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Sub domain configuration for the GSLB. GSLB service's FQDN must be a match one of these subdomains. . DNSConfigs []*DNSConfig `json:"dns_configs,omitempty"` // Frequency with which errored messages are resynced to follower sites. Value of 0 disables resync behavior. Allowed values are 60-3600. Special values are 0 - 'Disable'. Field introduced in 18.2.3. Unit is SEC. ErrorResyncInterval *int32 `json:"error_resync_interval,omitempty"` // This field indicates that this object is replicated across GSLB federation. Field introduced in 17.1.3. IsFederated *bool `json:"is_federated,omitempty"` // Mark this Site as leader of GSLB configuration. This site is the one among the Avi sites. // Required: true LeaderClusterUUID *string `json:"leader_cluster_uuid"` // This field disables the configuration operations on the leader for all federated objects. CUD operations on Gslb, GslbService, GslbGeoDbProfile and other federated objects will be rejected. The rest-api disabling helps in upgrade scenarios where we don't want configuration sync operations to the Gslb member when the member is being upgraded. This configuration programmatically blocks the leader from accepting new Gslb configuration when member sites are undergoing upgrade. . Field introduced in 17.2.1. MaintenanceMode *bool `json:"maintenance_mode,omitempty"` // Name for the GSLB object. // Required: true Name *string `json:"name"` // Policy for replicating configuration to the active follower sites. Field introduced in 20.1.1. ReplicationPolicy *ReplicationPolicy `json:"replication_policy,omitempty"` // Frequency with which group members communicate. Allowed values are 1-3600. Unit is SEC. SendInterval *int32 `json:"send_interval,omitempty"` // The user can specify a send-interval while entering maintenance mode. The validity of this 'maintenance send-interval' is only during maintenance mode. When the user leaves maintenance mode, the original send-interval is reinstated. This internal variable is used to store the original send-interval. . Field introduced in 18.2.3. Unit is SEC. SendIntervalPriorToMaintenanceMode *int32 `json:"send_interval_prior_to_maintenance_mode,omitempty"` // Select Avi site member belonging to this Gslb. Minimum of 1 items required. Sites []*GslbSite `json:"sites,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // This field indicates tenant visibility for GS pool member selection across the Gslb federated objects. Field introduced in 18.2.12,20.1.4. TenantScoped *bool `json:"tenant_scoped,omitempty"` // Third party site member belonging to this Gslb. Field introduced in 17.1.1. ThirdPartySites []*GslbThirdPartySite `json:"third_party_sites,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the GSLB object. UUID *string `json:"uuid,omitempty"` // The view-id is used in change-leader mode to differentiate partitioned groups while they have the same GSLB namespace. Each partitioned group will be able to operate independently by using the view-id. ViewID *int64 `json:"view_id,omitempty"` }
Gslb gslb swagger:model Gslb
type GslbAPIResponse ¶
type GslbAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Gslb `json:"results,omitempty"` }
GslbAPIResponse gslb Api response swagger:model GslbApiResponse
type GslbClientIPAddrGroup ¶
type GslbClientIPAddrGroup struct { // Configure IP address(es). Field introduced in 17.1.2. Addrs []*IPAddr `json:"addrs,omitempty"` // Configure IP address prefix(es). Field introduced in 17.1.2. Prefixes []*IPAddrPrefix `json:"prefixes,omitempty"` // Configure IP address range(s). Field introduced in 17.1.2. Ranges []*IPAddrRange `json:"ranges,omitempty"` // Specify whether this client IP address range is public or private. Enum options - GSLB_IP_PUBLIC, GSLB_IP_PRIVATE. Field introduced in 17.1.2. // Required: true Type *string `json:"type"` }
GslbClientIPAddrGroup gslb client Ip addr group swagger:model GslbClientIpAddrGroup
type GslbDNSGeoUpdate ¶
type GslbDNSGeoUpdate struct { // GslbGeoDbProfile object that is pushed on on a per Dns basis. Field deprecated in 18.1.5, 18.2.1. Field introduced in 17.1.1. ObjInfo []*GslbObjectInfo `json:"obj_info,omitempty"` // Enum options - GSLB_NONE, GSLB_CREATE, GSLB_UPDATE, GSLB_DELETE, GSLB_PURGE, GSLB_DECL. Field deprecated in 18.1.5, 18.2.1. Field introduced in 17.1.1. Ops *string `json:"ops,omitempty"` // Field deprecated in 18.1.5, 18.2.1. Field introduced in 17.1.1. SeList []string `json:"se_list,omitempty"` }
GslbDNSGeoUpdate gslb Dns geo update swagger:model GslbDnsGeoUpdate
type GslbDNSGsStatus ¶
type GslbDNSGsStatus struct { // Field introduced in 17.1.1. LastChangedTime *TimeStamp `json:"last_changed_time,omitempty"` // Counter to track the number of partial updates sent. Once it reaches the partial updates threshold, a full update is sent. Field introduced in 17.1.1. NumPartialUpdates *int32 `json:"num_partial_updates,omitempty"` // Threshold after which a full GS Status is sent. . Field introduced in 17.1.1. PartialUpdateThreshold *int32 `json:"partial_update_threshold,omitempty"` // State variable to trigger full or partial update. Enum options - GSLB_FULL_UPDATE_PENDING, GSLB_PARTIAL_UPDATE_PENDING. Field introduced in 17.1.1. State *string `json:"state,omitempty"` // Describes the type (partial/full) of the last GS status sent to Dns-VS(es). Enum options - GSLB_NO_UPDATE, GSLB_FULL_UPDATE, GSLB_PARTIAL_UPDATE. Field introduced in 17.1.1. Type *string `json:"type,omitempty"` }
GslbDNSGsStatus gslb Dns gs status swagger:model GslbDnsGsStatus
type GslbDNSInfo ¶
type GslbDNSInfo struct { // This field indicates that atleast one DNS is active at the site. DNSActive *bool `json:"dns_active,omitempty"` // Placeholder for description of property dns_vs_states of obj type GslbDnsInfo field type str type object DNSVsStates []*GslbPerDNSState `json:"dns_vs_states,omitempty"` // This field encapsulates the Gs-status edge-triggered framework. . Field introduced in 17.1.1. GsStatus *GslbDNSGsStatus `json:"gs_status,omitempty"` // This field is used to track the retry attempts for SE download errors. . Field introduced in 17.1.1. RetryCount *int32 `json:"retry_count,omitempty"` // This tables holds all the se-related info across all DNS-VS(es). . Field deprecated in 18.2.3. Field introduced in 17.1.1. SeTable []*GslbDNSSeInfo `json:"se_table,omitempty"` }
GslbDNSInfo gslb Dns info swagger:model GslbDnsInfo
type GslbDNSSeInfo ¶
type GslbDNSSeInfo struct { // This field describes the fd download status to the SE. Field deprecated in 18.2.3. Field introduced in 17.1.1. FdDownload *GslbDownloadStatus `json:"fd_download,omitempty"` // Geo files queue for sequencing files to SE. Field deprecated in 18.2.3. Field introduced in 17.1.1. FdInfo *ConfigInfo `json:"fd_info,omitempty"` // Service engine's fabric IP used to push Geo files. Field deprecated in 18.2.3. Field introduced in 17.1.1. IP *IPAddr `json:"ip,omitempty"` // UUID of the service engine. Field deprecated in 18.2.3. Field introduced in 17.1.1. UUID *string `json:"uuid,omitempty"` }
GslbDNSSeInfo gslb Dns se info swagger:model GslbDnsSeInfo
type GslbDNSUpdate ¶
type GslbDNSUpdate struct { // Number of clear_on_max_retries. ClearOnMaxRetries *int32 `json:"clear_on_max_retries,omitempty"` // List of Geo DB Profiles associated with this DNS VS. Field introduced in 18.2.3. GslbGeoDbProfileUuids []string `json:"gslb_geo_db_profile_uuids,omitempty"` // List of Gslb Services associated with the DNS VS. Field introduced in 18.2.3. GslbServiceUuids []string `json:"gslb_service_uuids,omitempty"` // Gslb object associated with the DNS VS. Field introduced in 18.2.3. GslbUuids []string `json:"gslb_uuids,omitempty"` // Gslb, GslbService objects that is pushed on a per Dns basis. Field introduced in 17.1.1. ObjInfo []*GslbObjectInfo `json:"obj_info,omitempty"` // Number of send_interval. SendInterval *int32 `json:"send_interval,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
GslbDNSUpdate gslb Dns update swagger:model GslbDnsUpdate
type GslbDownloadStatus ¶
type GslbDownloadStatus struct { // Field introduced in 17.1.1. LastChangedTime *TimeStamp `json:"last_changed_time,omitempty"` // This field indicates the download state to a dns-vs(es) or a VS or a SE depending on the usage context. . Enum options - GSLB_DOWNLOAD_NONE, GSLB_DOWNLOAD_DONE, GSLB_DOWNLOAD_PENDING, GSLB_DOWNLOAD_ERROR. Field introduced in 17.1.1. State *string `json:"state,omitempty"` }
GslbDownloadStatus gslb download status swagger:model GslbDownloadStatus
type GslbGeoDbEntry ¶
type GslbGeoDbEntry struct { // This field describes the GeoDb file. Field introduced in 17.1.1. // Required: true File *GslbGeoDbFile `json:"file"` // Priority of this geodb entry. This value should be unique in a repeated list of geodb entries. Higher the value, then greater is the priority. . Allowed values are 1-100. Field introduced in 17.1.1. Priority *int32 `json:"priority,omitempty"` }
GslbGeoDbEntry gslb geo db entry swagger:model GslbGeoDbEntry
type GslbGeoDbFile ¶
type GslbGeoDbFile struct { // File checksum is internally computed. Field introduced in 17.1.1. // Read Only: true Checksum *string `json:"checksum,omitempty"` // System internal identifier for the file. Field introduced in 17.1.1. // Read Only: true FileID *string `json:"file_id,omitempty"` // Geodb Filename in the Avi supported formats. Field introduced in 17.1.1. Filename *string `json:"filename,omitempty"` // This field indicates the file format. Enum options - GSLB_GEODB_FILE_FORMAT_AVI, GSLB_GEODB_FILE_FORMAT_MAXMIND_CITY, GSLB_GEODB_FILE_FORMAT_MAXMIND_CITY_V6, GSLB_GEODB_FILE_FORMAT_MAXMIND_CITY_V4_AND_V6, GSLB_GEODB_FILE_FORMAT_AVI_V6, GSLB_GEODB_FILE_FORMAT_AVI_V4_AND_V6. Field introduced in 17.1.1. Format *string `json:"format,omitempty"` // Internal timestamp associated with the file. Field introduced in 17.1.1. // Read Only: true Timestamp *int64 `json:"timestamp,omitempty"` }
GslbGeoDbFile gslb geo db file swagger:model GslbGeoDbFile
type GslbGeoDbProfile ¶
type GslbGeoDbProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Field introduced in 17.1.1. Description *string `json:"description,omitempty"` // List of Geodb entries. An entry can either be a geodb file or an ip address group with geo properties. . Field introduced in 17.1.1. Minimum of 1 items required. Entries []*GslbGeoDbEntry `json:"entries,omitempty"` // This field indicates that this object is replicated across GSLB federation. Field introduced in 17.1.3. IsFederated *bool `json:"is_federated,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // A user-friendly name for the geodb profile. Field introduced in 17.1.1. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 17.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the geodb profile. Field introduced in 17.1.1. UUID *string `json:"uuid,omitempty"` }
GslbGeoDbProfile gslb geo db profile swagger:model GslbGeoDbProfile
type GslbGeoDbProfileAPIResponse ¶
type GslbGeoDbProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*GslbGeoDbProfile `json:"results,omitempty"` }
GslbGeoDbProfileAPIResponse gslb geo db profile Api response swagger:model GslbGeoDbProfileApiResponse
type GslbGeoLocation ¶
type GslbGeoLocation struct { // Geographic location of the site. Field introduced in 17.1.1. Location *GeoLocation `json:"location,omitempty"` // This field describes the source of the GeoLocation. . Enum options - GSLB_LOCATION_SRC_USER_CONFIGURED, GSLB_LOCATION_SRC_INHERIT_FROM_SITE, GSLB_LOCATION_SRC_FROM_GEODB. Field introduced in 17.1.1. // Required: true Source *string `json:"source"` }
GslbGeoLocation gslb geo location swagger:model GslbGeoLocation
type GslbHealthMonitorProxy ¶
type GslbHealthMonitorProxy struct { // This field identifies the health monitor proxy behavior. The designated site for health monitor proxy can monitor public or private or all the members of a given site. . Enum options - GSLB_HEALTH_MONITOR_PROXY_ALL_MEMBERS, GSLB_HEALTH_MONITOR_PROXY_PRIVATE_MEMBERS. Field introduced in 17.1.1. ProxyType *string `json:"proxy_type,omitempty"` // This field identifies the site that will health monitor on behalf of the current site. i.e. it will be a health monitor proxy and monitor members of the current site. . Field introduced in 17.1.1. SiteUUID *string `json:"site_uuid,omitempty"` }
GslbHealthMonitorProxy gslb health monitor proxy swagger:model GslbHealthMonitorProxy
type GslbIPAddr ¶
type GslbIPAddr struct { // Public IP address of the pool member. Field introduced in 17.1.2. IP *IPAddr `json:"ip,omitempty"` }
GslbIPAddr gslb Ip addr swagger:model GslbIpAddr
type GslbObj ¶
type GslbObj struct { // Field introduced in 18.1.5, 18.2.1. GslbGeoDbProfileUUID *string `json:"gslb_geo_db_profile_uuid,omitempty"` // Field introduced in 18.1.5, 18.2.1. GslbServiceUUID *string `json:"gslb_service_uuid,omitempty"` // Field introduced in 18.1.5, 18.2.1. GslbUUID *string `json:"gslb_uuid,omitempty"` }
GslbObj gslb obj swagger:model GslbObj
type GslbObjectInfo ¶
type GslbObjectInfo struct { // Indicates the object uuid. Field introduced in 18.1.5, 18.2.1. Obj *GslbObj `json:"obj,omitempty"` // Indicates the object uuid. Field introduced in 17.1.1. ObjectUUID *string `json:"object_uuid,omitempty"` // Indicates the object type Gslb, GslbService or GslbGeoDbProfile. . Field introduced in 17.1.1. PbName *string `json:"pb_name,omitempty"` // Indicates the state of the object unchanged or changed. This is used in vs-mgr to push just the uuid or uuid + protobuf to the SE-Agent. Enum options - GSLB_OBJECT_CHANGED, GSLB_OBJECT_UNCHANGED, GSLB_OBJECT_DELETE. Field introduced in 17.1.1. State *string `json:"state,omitempty"` }
GslbObjectInfo gslb object info swagger:model GslbObjectInfo
type GslbPerDNSState ¶
type GslbPerDNSState struct { // This field describes the GeoDbProfile download status to the dns-vs. Field introduced in 17.1.1. GeoDownload *GslbDownloadStatus `json:"geo_download,omitempty"` // This field describes the Gslb, GslbService, HealthMonitor download status to the dns-vs. Field introduced in 17.1.1. GslbDownload *GslbDownloadStatus `json:"gslb_download,omitempty"` // Configured dns-vs-name at the site. Name *string `json:"name,omitempty"` // Placeholder for description of property oper_status of obj type GslbPerDnsState field type str type object OperStatus *OperationalStatus `json:"oper_status,omitempty"` // This field describes the SubDomain placement rules for this DNS-VS. Field introduced in 17.2.3. PlacementRules []*GslbSubDomainPlacementRuntime `json:"placement_rules,omitempty"` // The service engines associated with the DNS-VS. Field introduced in 17.1.1. SeList []string `json:"se_list,omitempty"` // Configured dns-vs-uuid at the site. UUID *string `json:"uuid,omitempty"` // This field indicates that the local VS is configured to be a DNS service. The services, network profile and application profile are configured in Virtual Service for DNS operations. . ValidDNSVs *bool `json:"valid_dns_vs,omitempty"` }
GslbPerDNSState gslb per Dns state swagger:model GslbPerDnsState
type GslbPool ¶
type GslbPool struct { // The load balancing algorithm will pick a local member within the GSLB service list of available Members. Enum options - GSLB_ALGORITHM_ROUND_ROBIN, GSLB_ALGORITHM_CONSISTENT_HASH, GSLB_ALGORITHM_GEO, GSLB_ALGORITHM_TOPOLOGY. // Required: true Algorithm *string `json:"algorithm"` // Mask to be applied on client IP for consistent hash algorithm. Allowed values are 1-31. ConsistentHashMask *int32 `json:"consistent_hash_mask,omitempty"` // Mask to be applied on client IPV6 address for consistent hash algorithm. Allowed values are 1-127. Field introduced in 18.2.8, 20.1.1. ConsistentHashMask6 *int32 `json:"consistent_hash_mask6,omitempty"` // User provided information that records member details such as application owner name, contact, etc. Field introduced in 17.1.3. Description *string `json:"description,omitempty"` // Enable or disable a GSLB service pool. Field introduced in 17.2.14, 18.1.5, 18.2.1. Enabled *bool `json:"enabled,omitempty"` // The fallback load balancing algorithm used to pick a member when the pool algorithm fails to find a valid member. For instance when algorithm is Geo and client/server do not have valid geo location. Enum options - GSLB_ALGORITHM_ROUND_ROBIN, GSLB_ALGORITHM_CONSISTENT_HASH, GSLB_ALGORITHM_GEO, GSLB_ALGORITHM_TOPOLOGY. Field introduced in 18.2.3. FallbackAlgorithm *string `json:"fallback_algorithm,omitempty"` // Select list of VIPs belonging to this GSLB service. Minimum of 1 items required. Members []*GslbPoolMember `json:"members,omitempty"` // Minimum number of health monitors in UP state to mark the member UP. Field introduced in 20.1.1. MinHealthMonitorsUp *int32 `json:"min_health_monitors_up,omitempty"` // Name of the GSLB service pool. // Required: true Name *string `json:"name"` // Priority of this pool of Members. The higher the number, the higher is the priority of the pool. The DNS Service chooses the pool with the highest priority that is operationally up. Allowed values are 0-100. Special values are 0 - 'Do not choose members from this pool.A priority of 0 is equivalent to disabling the pool.'. Priority *int32 `json:"priority,omitempty"` }
GslbPool gslb pool swagger:model GslbPool
type GslbPoolMember ¶
type GslbPoolMember struct { // The Cloud UUID of the Site. Field introduced in 17.1.2. CloudUUID *string `json:"cloud_uuid,omitempty"` // The Cluster UUID of the Site. ClusterUUID *string `json:"cluster_uuid,omitempty"` // User provided information that records member details such as application owner name, contact, etc. Field introduced in 17.1.3. Description *string `json:"description,omitempty"` // Enable or Disable member to decide if this address should be provided in DNS responses. Enabled *bool `json:"enabled,omitempty"` // The pool member is configured with a fully qualified domain name. The FQDN is resolved to an IP address by the controller. DNS service shall health monitor the resolved IP address while it will return the fqdn(cname) in the DNS response.If the user has configured an IP address (in addition to the FQDN), then the IP address will get overwritten whenever periodic FQDN refresh is done by the controller. . Fqdn *string `json:"fqdn,omitempty"` // Internal generated system-field. Field deprecated in 18.2.2. Field introduced in 17.1.1. HmProxies []*GslbHealthMonitorProxy `json:"hm_proxies,omitempty"` // Hostname to be used as host header for http health monitors and as TLS server name for https health monitors.(By default, the fqdn of the GSLB pool member or GSLB service is used.) Note this field is not used as http host header when exact_http_request is set in the health monitor. . Field introduced in 18.2.5. Hostname *string `json:"hostname,omitempty"` // IP address of the pool member. If this IP address is hosted via an AVI virtual service, then the user should configure the cluster uuid and virtual service uuid. If this IP address is hosted on a third-party device and the device is tagged/tethered to a third-party site, then user can configure the third-party site uuid. User may configure the IP address without the cluster uuid or the virtual service uuid. In this option, some advanced site related features cannot be enabled. If the user has configured a fqdn for the pool member, then it takes precedence and will overwrite the configured IP address. . IP *IPAddr `json:"ip,omitempty"` // Geographic location of the pool member. Field introduced in 17.1.1. Location *GslbGeoLocation `json:"location,omitempty"` // Alternate IP addresses of the pool member. In usual deployments, the VIP in the virtual service is a private IP address. This gets configured in the 'ip' field of the GSLB service. This field is used to host the public IP address for the VIP, which gets NATed to the private IP by a firewall. Client DNS requests coming in from within the intranet should have the private IP served in the A record, and requests from outside this should be served the public IP address. Field introduced in 17.1.2. PublicIP *GslbIPAddr `json:"public_ip,omitempty"` // Overrides the default ratio of 1. Reduces the percentage the LB algorithm would pick the server in relation to its peers. Range is 1-20. Allowed values are 1-20. Ratio *int32 `json:"ratio,omitempty"` // This field indicates if the fqdn should be resolved to a v6 or a v4 address family. . Field introduced in 18.2.8, 20.1.1. ResolveFqdnToV6 *bool `json:"resolve_fqdn_to_v6,omitempty"` // Select local virtual service in the specified controller cluster belonging to this GSLB service. The virtual service may have multiple IP addresses and FQDNs. User will have to choose IP address or FQDN and configure it in the respective field. . VsUUID *string `json:"vs_uuid,omitempty"` }
GslbPoolMember gslb pool member swagger:model GslbPoolMember
type GslbPoolMemberDatapathStatus ¶
type GslbPoolMemberDatapathStatus struct { // Field introduced in 17.1.1. Location *GeoLocation `json:"location,omitempty"` // Placeholder for description of property oper_status of obj type GslbPoolMemberDatapathStatus field type str type object OperStatus *OperationalStatus `json:"oper_status,omitempty"` // Unique object identifier of site. SiteUUID *string `json:"site_uuid,omitempty"` }
GslbPoolMemberDatapathStatus gslb pool member datapath status swagger:model GslbPoolMemberDatapathStatus
type GslbPoolMemberRuntimeInfo ¶
type GslbPoolMemberRuntimeInfo struct { // Application type of the VS. Enum options - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS, APPLICATION_PROFILE_TYPE_SSL, APPLICATION_PROFILE_TYPE_SIP. Field introduced in 17.2.2. AppType *string `json:"app_type,omitempty"` // The Site Controller Cluster UUID to which this member belongs. ClusterUUID *string `json:"cluster_uuid,omitempty"` // Controller retrieved member status at the site. ControllerStatus *OperationalStatus `json:"controller_status,omitempty"` // DNS computed member status from different sites. DatapathStatus []*GslbPoolMemberDatapathStatus `json:"datapath_status,omitempty"` // FQDN address of the member. . Fqdn *string `json:"fqdn,omitempty"` // gs_name of GslbPoolMemberRuntimeInfo. GsName *string `json:"gs_name,omitempty"` // The GSLB service to which this member belongs. GsUUID *string `json:"gs_uuid,omitempty"` // GSLB pool member's configured VIP. . IP *IPAddr `json:"ip,omitempty"` // This is an internal field that conveys the IP address from the controller to service engine in binary format. . IPValueToSe *int32 `json:"ip_value_to_se,omitempty"` // This is an internal field that conveys the IPV6 address from the controller to service engine in binary format. . Field introduced in 18.2.8, 20.1.1. IPV6ValueToSe []int64 `json:"ipv6_value_to_se,omitempty,omitempty"` // Operational VIPs of the member that can map to multiple VS IP addresses such as private, public and floating addresses. OperIps []*IPAddr `json:"oper_ips,omitempty"` // Gslb Pool member's consolidated operational status . OperStatus *OperationalStatus `json:"oper_status,omitempty"` // services configured on the virtual service. Services []*Service `json:"services,omitempty"` // The Site 's name is required for event-generation etc. SiteName *string `json:"site_name,omitempty"` // Site persistence pools associated with the VS. Field introduced in 17.2.2. SpPools []*GslbServiceSitePersistencePool `json:"sp_pools,omitempty"` // Describes the VIP type Avi or third-party. Enum options - NON_AVI_VIP, AVI_VIP. VipType *string `json:"vip_type,omitempty"` // VS name belonging to this GSLB service. VsName *string `json:"vs_name,omitempty"` // VS UUID belonging to this GSLB service. VsUUID *string `json:"vs_uuid,omitempty"` // Front end L4 metrics of the virtual service. VserverL4Metrics *VserverL4MetricsObj `json:"vserver_l4_metrics,omitempty"` // Front end L7 metrics of the virtual service. VserverL7Metrics *VserverL7MetricsObj `json:"vserver_l7_metrics,omitempty"` }
GslbPoolMemberRuntimeInfo gslb pool member runtime info swagger:model GslbPoolMemberRuntimeInfo
type GslbPoolRuntime ¶
type GslbPoolRuntime struct { // Placeholder for description of property members of obj type GslbPoolRuntime field type str type object Members []*GslbPoolMemberRuntimeInfo `json:"members,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Gslb Pool's consolidated operational status . Field introduced in 18.2.3. OperStatus *OperationalStatus `json:"oper_status,omitempty"` }
GslbPoolRuntime gslb pool runtime swagger:model GslbPoolRuntime
type GslbReplicationStats ¶
type GslbReplicationStats struct { // Last config version acknowledged. Field introduced in 20.1.1. AcknowledgedVersion *int64 `json:"acknowledged_version,omitempty"` // Number of pending objects. Field introduced in 20.1.1. PendingObjectCount *int64 `json:"pending_object_count,omitempty"` // Last config version received. On leader, this represents the version received from federated datastore. Field introduced in 20.1.1. ReceivedVersion *int64 `json:"received_version,omitempty"` }
GslbReplicationStats gslb replication stats swagger:model GslbReplicationStats
type GslbRuntime ¶
type GslbRuntime struct { // Field introduced in 17.1.3. Checksum *string `json:"checksum,omitempty"` // This field indicates delete is in progress for this Gslb instance. . Field introduced in 17.2.5. DeleteInProgress *bool `json:"delete_in_progress,omitempty"` // Placeholder for description of property dns_enabled of obj type GslbRuntime field type str type boolean DNSEnabled *bool `json:"dns_enabled,omitempty"` // Placeholder for description of property event_cache of obj type GslbRuntime field type str type object EventCache *EventCache `json:"event_cache,omitempty"` // Placeholder for description of property flr_state of obj type GslbRuntime field type str type object FlrState []*CfgState `json:"flr_state,omitempty"` // Placeholder for description of property ldr_state of obj type GslbRuntime field type str type object LdrState *CfgState `json:"ldr_state,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Placeholder for description of property site of obj type GslbRuntime field type str type object Site []*GslbSiteRuntime `json:"site,omitempty"` // Remap the tenant_uuid to its tenant-name so that we can use the tenant_name directly in remote-site ops. . Field introduced in 17.2.3. TenantName *string `json:"tenant_name,omitempty"` // Field introduced in 17.1.1. ThirdPartySites []*GslbThirdPartySiteRuntime `json:"third_party_sites,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
GslbRuntime gslb runtime swagger:model GslbRuntime
type GslbService ¶
type GslbService struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // The federated application persistence associated with GslbService site persistence functionality. . It is a reference to an object of type ApplicationPersistenceProfile. Field introduced in 17.2.1. ApplicationPersistenceProfileRef *string `json:"application_persistence_profile_ref,omitempty"` // GS member's overall health status is derived based on a combination of controller and datapath health-status inputs. Note that the datapath status is determined by the association of health monitor profiles. Only the controller provided status is determined through this configuration. . ControllerHealthStatusEnabled *bool `json:"controller_health_status_enabled,omitempty"` // Creator name. Field introduced in 17.1.2. CreatedBy *string `json:"created_by,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Fully qualified domain name of the GSLB service. Minimum of 1 items required. DomainNames []string `json:"domain_names,omitempty"` // Response to the client query when the GSLB service is DOWN. DownResponse *GslbServiceDownResponse `json:"down_response,omitempty"` // Enable or disable the GSLB service. If the GSLB service is enabled, then the VIPs are sent in the DNS responses based on reachability and configured algorithm. If the GSLB service is disabled, then the VIPs are no longer available in the DNS response. Enabled *bool `json:"enabled,omitempty"` // Select list of pools belonging to this GSLB service. Minimum of 1 items required. Groups []*GslbPool `json:"groups,omitempty"` // Verify VS health by applying one or more health monitors. Active monitors generate synthetic traffic from DNS Service Engine and to mark a VS up or down based on the response. . It is a reference to an object of type HealthMonitor. Maximum of 6 items allowed. HealthMonitorRefs []string `json:"health_monitor_refs,omitempty"` // Health monitor probe can be executed for all the members or it can be executed only for third-party members. This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario. In such a case, Avi members can have controller derived status while Non-Avi members can be probed by via health monitor probes in dataplane. Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. HealthMonitorScope *string `json:"health_monitor_scope,omitempty"` // This field is an internal field and is used in SE. Field introduced in 18.2.2. HmOff *bool `json:"hm_off,omitempty"` // This field indicates that this object is replicated across GSLB federation. Field introduced in 17.1.3. IsFederated *bool `json:"is_federated,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // The minimum number of members to distribute traffic to. Allowed values are 1-65535. Special values are 0 - 'Disable'. Field introduced in 17.2.4. MinMembers *int32 `json:"min_members,omitempty"` // Name for the GSLB service. // Required: true Name *string `json:"name"` // Number of IP addresses of this GSLB service to be returned by the DNS Service. Enter 0 to return all IP addresses. Allowed values are 1-20. Special values are 0- 'Return all IP addresses'. NumDNSIP *int32 `json:"num_dns_ip,omitempty"` // The load balancing algorithm will pick a GSLB pool within the GSLB service list of available pools. Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Field introduced in 17.2.3. PoolAlgorithm *string `json:"pool_algorithm,omitempty"` // This field indicates that for a CNAME query, respond with resolved CNAMEs in the additional section with A records. Field introduced in 18.2.5. ResolveCname *bool `json:"resolve_cname,omitempty"` // Enable site-persistence for the GslbService. . Field introduced in 17.2.1. SitePersistenceEnabled *bool `json:"site_persistence_enabled,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // TTL value (in seconds) for records served for this GSLB service by the DNS Service. Allowed values are 0-86400. Unit is SEC. TTL *int32 `json:"ttl,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Use the client ip subnet from the EDNS option as source IPaddress for client geo-location and consistent hash algorithm. Default is true. Field introduced in 17.1.1. UseEdnsClientSubnet *bool `json:"use_edns_client_subnet,omitempty"` // UUID of the GSLB service. UUID *string `json:"uuid,omitempty"` // Enable wild-card match of fqdn if an exact match is not found in the DNS table, the longest match is chosen by wild-carding the fqdn in the DNS request. Default is false. Field introduced in 17.1.1. WildcardMatch *bool `json:"wildcard_match,omitempty"` }
GslbService gslb service swagger:model GslbService
type GslbServiceAPIResponse ¶
type GslbServiceAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*GslbService `json:"results,omitempty"` }
GslbServiceAPIResponse gslb service Api response swagger:model GslbServiceApiResponse
type GslbServiceDownResponse ¶
type GslbServiceDownResponse struct { // Fallback IP address to use in A response to the client query when the GSLB service is DOWN. FallbackIP *IPAddr `json:"fallback_ip,omitempty"` // Fallback IPV6 address to use in AAAA response to the client query when the GSLB service is DOWN. Field introduced in 18.2.8. FallbackIp6 *IPAddr `json:"fallback_ip6,omitempty"` // Response from DNS service towards the client when the GSLB service is DOWN. Enum options - GSLB_SERVICE_DOWN_RESPONSE_NONE, GSLB_SERVICE_DOWN_RESPONSE_ALL_RECORDS, GSLB_SERVICE_DOWN_RESPONSE_FALLBACK_IP, GSLB_SERVICE_DOWN_RESPONSE_EMPTY. // Required: true Type *string `json:"type"` }
GslbServiceDownResponse gslb service down response swagger:model GslbServiceDownResponse
type GslbServiceRuntime ¶
type GslbServiceRuntime struct { // Field introduced in 17.1.3. Checksum *string `json:"checksum,omitempty"` // Placeholder for description of property flr_state of obj type GslbServiceRuntime field type str type object FlrState []*CfgState `json:"flr_state,omitempty"` // Placeholder for description of property groups of obj type GslbServiceRuntime field type str type object Groups []*GslbPoolRuntime `json:"groups,omitempty"` // Placeholder for description of property ldr_state of obj type GslbServiceRuntime field type str type object LdrState *CfgState `json:"ldr_state,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Placeholder for description of property oper_status of obj type GslbServiceRuntime field type str type object OperStatus *OperationalStatus `json:"oper_status,omitempty"` // Field introduced in 17.2.1. SendEvent *bool `json:"send_event,omitempty"` // Field introduced in 17.2.1. SendStatus *bool `json:"send_status,omitempty"` // services_state of GslbServiceRuntime. ServicesState *string `json:"services_state,omitempty"` // Gslb site persistence consolidated status . Field introduced in 17.2.2. SpOperStatus *OperationalStatus `json:"sp_oper_status,omitempty"` // Tenant name (and not uuid) is required in logs/metrics generated by the SE. . TenantName *string `json:"tenant_name,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
GslbServiceRuntime gslb service runtime swagger:model GslbServiceRuntime
type GslbServiceSitePersistencePool ¶
type GslbServiceSitePersistencePool struct { // Site persistence pool's name. . Field introduced in 17.2.2. Name *string `json:"name,omitempty"` // Number of servers configured in the pool. . Field introduced in 17.2.2. NumServers *int64 `json:"num_servers,omitempty"` // Number of servers operationally up in the pool. . Field introduced in 17.2.2. NumServersUp *int64 `json:"num_servers_up,omitempty"` // Detailed information of the servers in the pool. . Field introduced in 17.2.8. Servers []*ServerConfig `json:"servers,omitempty"` // Site persistence pool's uuid. . Field introduced in 17.2.2. UUID *string `json:"uuid,omitempty"` }
GslbServiceSitePersistencePool gslb service site persistence pool swagger:model GslbServiceSitePersistencePool
type GslbServiceStatus ¶
type GslbServiceStatus struct { // details of GslbServiceStatus. Details []string `json:"details,omitempty"` // Placeholder for description of property gs_runtime of obj type GslbServiceStatus field type str type object GsRuntime *GslbServiceRuntime `json:"gs_runtime,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
GslbServiceStatus gslb service status swagger:model GslbServiceStatus
type GslbSite ¶
type GslbSite struct { // IP Address or a DNS resolvable, fully qualified domain name of the Site Controller Cluster. Address *string `json:"address,omitempty"` // UUID of the 'Cluster' object of the Controller Cluster in this site. // Required: true ClusterUUID *string `json:"cluster_uuid"` // The DNS VSes on which the GslbServices shall be placed. The site has to be an ACTIVE member. This field is deprecated in 17.2.3 and replaced by 'dns_vses' field. . Field deprecated in 17.2.3. DNSVsUuids []string `json:"dns_vs_uuids,omitempty"` // This field identifies the DNS VS and the subdomains it hosts for Gslb services. . Field introduced in 17.2.3. DNSVses []*GslbSiteDNSVs `json:"dns_vses,omitempty"` // Enable or disable the Site. This is useful in maintenance scenarios such as upgrade and routine maintenance. A disabled site's configuration shall be retained but it will not get any new configuration updates. It shall not participate in Health-Status monitoring. VIPs of the Virtual Services on the disabled site shall not be sent in DNS response. When a site transitions from disabled to enabled, it is treated similar to the addition of a new site. Enabled *bool `json:"enabled,omitempty"` // User can designate certain Avi sites to run health monitor probes for VIPs/VS(es) for this site. This is useful in network deployments where the VIPs/VS(es) are reachable only from certain sites. A typical scenario is a firewall between two GSLB sites. User may want to run health monitor probes from sites on either side of the firewall so that each designated site can derive a datapath view of the reachable members. If the health monitor proxies are not configured, then the default behavior is to run health monitor probes from all the active sites. Field introduced in 17.1.1. HmProxies []*GslbHealthMonitorProxy `json:"hm_proxies,omitempty"` // This field enables the health monitor shard functionality on a site-basis. Field introduced in 18.2.2. HmShardEnabled *bool `json:"hm_shard_enabled,omitempty"` // IP Address(es) of the Site's Cluster. For a 3-node cluster, either the cluster vIP is provided, or the list of controller IPs in the cluster are provided. Maximum of 3 items allowed. IPAddresses []*IPAddr `json:"ip_addresses,omitempty"` // Geographic location of the site. Field introduced in 17.1.1. Location *GslbGeoLocation `json:"location,omitempty"` // The site's member type A leader is set to ACTIVE while allmembers are set to passive. . Enum options - GSLB_ACTIVE_MEMBER, GSLB_PASSIVE_MEMBER. MemberType *string `json:"member_type,omitempty"` // Name for the Site Controller Cluster. // Required: true Name *string `json:"name"` // The password used when authenticating with the Site. // Required: true Password *string `json:"password"` // The Site Controller Cluster's REST API port number. Allowed values are 1-65535. Port *int32 `json:"port,omitempty"` // User can overide the individual GslbPoolMember ratio for all the VIPs/VS(es) of this site. If this field is not configured then the GslbPoolMember ratio gets applied. . Allowed values are 1-20. Field introduced in 17.1.1. Ratio *int32 `json:"ratio,omitempty"` // This modes applies to follower sites. When an active site is in suspend mode, the site does not receive any further federated objects. Field introduced in 20.1.1. SuspendMode *bool `json:"suspend_mode,omitempty"` // The username used when authenticating with the Site. . // Required: true Username *string `json:"username"` // This field is used as a key in the datastore for the GslbSite table to encapsulate site-related info. . Field introduced in 17.2.5. UUID *string `json:"uuid,omitempty"` }
GslbSite gslb site swagger:model GslbSite
type GslbSiteCfgSyncInfo ¶
type GslbSiteCfgSyncInfo struct { // Objects that could NOT be synced to the site . ErroredObjects []*VersionInfo `json:"errored_objects,omitempty"` // Placeholder for description of property last_changed_time of obj type GslbSiteCfgSyncInfo field type str type object LastChangedTime *TimeStamp `json:"last_changed_time,omitempty"` // Configuration sync-state of the site . Enum options - GSLB_SITE_CFG_IN_SYNC, GSLB_SITE_CFG_OUT_OF_SYNC, GSLB_SITE_CFG_SYNC_DISABLED, GSLB_SITE_CFG_SYNC_IN_PROGRESS, GSLB_SITE_CFG_SYNC_NOT_APPLICABLE, GSLB_SITE_CFG_SYNCED_TILL_CHECKPOINT, GSLB_SITE_CFG_SYNC_SUSPENDED. SyncState *string `json:"sync_state,omitempty"` }
GslbSiteCfgSyncInfo gslb site cfg sync info swagger:model GslbSiteCfgSyncInfo
type GslbSiteDNSVs ¶
type GslbSiteDNSVs struct { // This field identifies the DNS VS uuid for this site. Field introduced in 17.2.3. // Required: true DNSVsUUID *string `json:"dns_vs_uuid"` // This field identifies the subdomains that are hosted on the DNS VS. GslbService(s) whose FQDNs map to one of the subdomains will be hosted on this DNS VS. If no subdomains are configured, then the default behavior is to host all the GslbServices on this DNS VS. Field introduced in 17.2.3. DomainNames []string `json:"domain_names,omitempty"` }
GslbSiteDNSVs gslb site Dns vs swagger:model GslbSiteDnsVs
type GslbSiteHealthStatus ¶
type GslbSiteHealthStatus struct { // Controller retrieved GSLB service operational info based of virtual service state. . ControllerGsinfo []*GslbPoolMemberRuntimeInfo `json:"controller_gsinfo,omitempty"` // Controller retrieved GSLB service operational info based of dns datapath resolution. This information is generated only on those sites that have DNS-VS participating in GSLB. DatapathGsinfo []*GslbPoolMemberRuntimeInfo `json:"datapath_gsinfo,omitempty"` // DNS info at the site. DNSInfo *GslbDNSInfo `json:"dns_info,omitempty"` // GSLB application persistence profile state at member. Field introduced in 17.1.1. GapTable []*CfgState `json:"gap_table,omitempty"` // GSLB Geo Db profile state at member. Field introduced in 17.1.1. GeoTable []*CfgState `json:"geo_table,omitempty"` // GSLB health monitor state at member. GhmTable []*CfgState `json:"ghm_table,omitempty"` // GSLB state at member. GlbTable []*CfgState `json:"glb_table,omitempty"` // GSLB service state at member. GsTable []*CfgState `json:"gs_table,omitempty"` // Current Software version of the site. SwVersion *string `json:"sw_version,omitempty"` // Timestamp of Health-Status generation. Timestamp *float32 `json:"timestamp,omitempty"` }
GslbSiteHealthStatus gslb site health status swagger:model GslbSiteHealthStatus
type GslbSiteRuntime ¶
type GslbSiteRuntime struct { // This field shadows glb_cfg.clear_on_max_retries. Field introduced in 17.2.5. ClearOnMaxRetries *int32 `json:"clear_on_max_retries,omitempty"` // This field tracks the glb-uuid. Field introduced in 17.2.5. GlbUUID *string `json:"glb_uuid,omitempty"` // Carries replication stats for a given site. Field introduced in 20.1.1. ReplicationStats *GslbReplicationStats `json:"replication_stats,omitempty"` // Placeholder for description of property rxed_site_hs of obj type GslbSiteRuntime field type str type object RxedSiteHs *GslbSiteHealthStatus `json:"rxed_site_hs,omitempty"` // Frequency with which group members communicate. This field shadows glb_cfg.send_interval. Field introduced in 17.2.5. SendInterval *int32 `json:"send_interval,omitempty"` // Placeholder for description of property site_cfg of obj type GslbSiteRuntime field type str type object SiteCfg *GslbSiteRuntimeCfg `json:"site_cfg,omitempty"` // Placeholder for description of property site_info of obj type GslbSiteRuntime field type str type object SiteInfo *GslbSiteRuntimeInfo `json:"site_info,omitempty"` // Placeholder for description of property site_stats of obj type GslbSiteRuntime field type str type object SiteStats *GslbSiteRuntimeStats `json:"site_stats,omitempty"` // Remap the tenant_uuid to its tenant-name so that we can use the tenant_name directly in remote-site ops. . Field introduced in 17.2.5. TenantName *string `json:"tenant_name,omitempty"` // This field shadows the glb_cfg.view_id. . Field introduced in 17.2.5. ViewID *int64 `json:"view_id,omitempty"` }
GslbSiteRuntime gslb site runtime swagger:model GslbSiteRuntime
type GslbSiteRuntimeCfg ¶
type GslbSiteRuntimeCfg struct { // Gslb GeoDb files published for a site. Field introduced in 17.1.1. FdInfo *ConfigInfo `json:"fd_info,omitempty"` // Gslb Application Persistence info published for a site. Field introduced in 17.1.1. GapInfo *ConfigInfo `json:"gap_info,omitempty"` // Gslb GeoDb info published for a site. Field introduced in 17.1.1. GeoInfo *ConfigInfo `json:"geo_info,omitempty"` // GHM info published for a site. GhmInfo *ConfigInfo `json:"ghm_info,omitempty"` // Gslb info published for a site. GlbInfo *ConfigInfo `json:"glb_info,omitempty"` // Gslb PKI info published for a site. Field introduced in 17.1.3. GpkiInfo *ConfigInfo `json:"gpki_info,omitempty"` // GS info published for a site. GsInfo *ConfigInfo `json:"gs_info,omitempty"` // Maintenance mode info published for a site. MmInfo *ConfigInfo `json:"mm_info,omitempty"` // The replication queue for all object-types for a site. Field introduced in 17.2.7. ReplQueue *ConfigInfo `json:"repl_queue,omitempty"` // Configuration sync-info of the site . SyncInfo *GslbSiteCfgSyncInfo `json:"sync_info,omitempty"` }
GslbSiteRuntimeCfg gslb site runtime cfg swagger:model GslbSiteRuntimeCfg
type GslbSiteRuntimeInfo ¶
type GslbSiteRuntimeInfo struct { // The Leader-IP/VIP/FQDN of the site-cluster. ClusterLeader *string `json:"cluster_leader,omitempty"` // Unique object identifier of cluster. ClusterUUID *string `json:"cluster_uuid,omitempty"` // operational dns state at the site. DNSInfo *GslbDNSInfo `json:"dns_info,omitempty"` // Enable/disable state retrieved from the cfg . Enabled *bool `json:"enabled,omitempty"` // event-cache used for event throttling. EventCache *EventCache `json:"event_cache,omitempty"` // Health-status monitoring enable or disable. HsState *bool `json:"hs_state,omitempty"` // Placeholder for description of property last_changed_time of obj type GslbSiteRuntimeInfo field type str type object LastChangedTime *TimeStamp `json:"last_changed_time,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Number of retry attempts to reach the remote site. NumOfRetries *int32 `json:"num_of_retries,omitempty"` // Placeholder for description of property oper_status of obj type GslbSiteRuntimeInfo field type str type object OperStatus *OperationalStatus `json:"oper_status,omitempty"` // Site Role Leader or Follower. Enum options - GSLB_LEADER, GSLB_MEMBER, GSLB_NOT_A_MEMBER. Role *string `json:"role,omitempty"` // Current outstanding request-response token of the message to this site. Rrtoken []string `json:"rrtoken,omitempty"` // Indicates if it is Avi Site or third-party. Enum options - GSLB_AVI_SITE, GSLB_THIRD_PARTY_SITE. Field introduced in 17.1.1. SiteType *string `json:"site_type,omitempty"` // Enum options - SITE_STATE_NULL, SITE_STATE_JOIN_IN_PROGRESS, SITE_STATE_LEAVE_IN_PROGRESS, SITE_STATE_INIT, SITE_STATE_UNREACHABLE, SITE_STATE_MMODE, SITE_STATE_DISABLE_IN_PROGRESS, SITE_STATE_DISABLED. State *string `json:"state,omitempty"` // State - Reason. StateReason *string `json:"state_reason,omitempty"` // Current Software version of the site. SwVersion *string `json:"sw_version,omitempty"` }
GslbSiteRuntimeInfo gslb site runtime info swagger:model GslbSiteRuntimeInfo
type GslbSiteRuntimeStats ¶
type GslbSiteRuntimeStats struct { // Field introduced in 17.1.1. NumFileCrTxed *int32 `json:"num_file_cr_txed,omitempty"` // Field introduced in 17.1.1. NumFileDelTxed *int32 `json:"num_file_del_txed,omitempty"` // Field introduced in 17.1.1. NumGapCrRxed *int32 `json:"num_gap_cr_rxed,omitempty"` // Field introduced in 17.1.1. NumGapCrTxed *int32 `json:"num_gap_cr_txed,omitempty"` // Field introduced in 17.1.1. NumGapDelRxed *int32 `json:"num_gap_del_rxed,omitempty"` // Field introduced in 17.1.1. NumGapDelTxed *int32 `json:"num_gap_del_txed,omitempty"` // Field introduced in 17.1.1. NumGapUpdRxed *int32 `json:"num_gap_upd_rxed,omitempty"` // Field introduced in 17.1.1. NumGapUpdTxed *int32 `json:"num_gap_upd_txed,omitempty"` // Field introduced in 17.1.1. NumGeoCrRxed *int32 `json:"num_geo_cr_rxed,omitempty"` // Field introduced in 17.1.1. NumGeoCrTxed *int32 `json:"num_geo_cr_txed,omitempty"` // Field introduced in 17.1.1. NumGeoDelRxed *int32 `json:"num_geo_del_rxed,omitempty"` // Field introduced in 17.1.1. NumGeoDelTxed *int32 `json:"num_geo_del_txed,omitempty"` // Field introduced in 17.1.1. NumGeoUpdRxed *int32 `json:"num_geo_upd_rxed,omitempty"` // Field introduced in 17.1.1. NumGeoUpdTxed *int32 `json:"num_geo_upd_txed,omitempty"` // Number of num_ghm_cr_rxed. NumGhmCrRxed *int32 `json:"num_ghm_cr_rxed,omitempty"` // Number of num_ghm_cr_txed. NumGhmCrTxed *int32 `json:"num_ghm_cr_txed,omitempty"` // Number of num_ghm_del_rxed. NumGhmDelRxed *int32 `json:"num_ghm_del_rxed,omitempty"` // Number of num_ghm_del_txed. NumGhmDelTxed *int32 `json:"num_ghm_del_txed,omitempty"` // Number of num_ghm_upd_rxed. NumGhmUpdRxed *int32 `json:"num_ghm_upd_rxed,omitempty"` // Number of num_ghm_upd_txed. NumGhmUpdTxed *int32 `json:"num_ghm_upd_txed,omitempty"` // Number of num_glb_cr_rxed. NumGlbCrRxed *int32 `json:"num_glb_cr_rxed,omitempty"` // Number of num_glb_cr_txed. NumGlbCrTxed *int32 `json:"num_glb_cr_txed,omitempty"` // Number of num_glb_del_rxed. NumGlbDelRxed *int32 `json:"num_glb_del_rxed,omitempty"` // Number of num_glb_del_txed. NumGlbDelTxed *int32 `json:"num_glb_del_txed,omitempty"` // Number of num_glb_upd_rxed. NumGlbUpdRxed *int32 `json:"num_glb_upd_rxed,omitempty"` // Number of num_glb_upd_txed. NumGlbUpdTxed *int32 `json:"num_glb_upd_txed,omitempty"` // Field introduced in 17.1.3. NumGpkiCrRxed *int32 `json:"num_gpki_cr_rxed,omitempty"` // Field introduced in 17.1.3. NumGpkiCrTxed *int32 `json:"num_gpki_cr_txed,omitempty"` // Field introduced in 17.1.3. NumGpkiDelRxed *int32 `json:"num_gpki_del_rxed,omitempty"` // Field introduced in 17.1.3. NumGpkiDelTxed *int32 `json:"num_gpki_del_txed,omitempty"` // Field introduced in 17.1.3. NumGpkiUpdRxed *int32 `json:"num_gpki_upd_rxed,omitempty"` // Field introduced in 17.1.3. NumGpkiUpdTxed *int32 `json:"num_gpki_upd_txed,omitempty"` // Number of num_gs_cr_rxed. NumGsCrRxed *int32 `json:"num_gs_cr_rxed,omitempty"` // Number of num_gs_cr_txed. NumGsCrTxed *int32 `json:"num_gs_cr_txed,omitempty"` // Number of num_gs_del_rxed. NumGsDelRxed *int32 `json:"num_gs_del_rxed,omitempty"` // Number of num_gs_del_txed. NumGsDelTxed *int32 `json:"num_gs_del_txed,omitempty"` // Number of num_gs_upd_rxed. NumGsUpdRxed *int32 `json:"num_gs_upd_rxed,omitempty"` // Number of num_gs_upd_txed. NumGsUpdTxed *int32 `json:"num_gs_upd_txed,omitempty"` // Number of num_health_msgs_rxed. NumHealthMsgsRxed *int32 `json:"num_health_msgs_rxed,omitempty"` // Number of num_health_msgs_txed. NumHealthMsgsTxed *int32 `json:"num_health_msgs_txed,omitempty"` // Number of num_of_bad_responses. NumOfBadResponses *int32 `json:"num_of_bad_responses,omitempty"` // Number of num_of_events_generated. NumOfEventsGenerated *int32 `json:"num_of_events_generated,omitempty"` // Number of num_of_skip_outstanding_requests. NumOfSkipOutstandingRequests *int32 `json:"num_of_skip_outstanding_requests,omitempty"` // Number of num_of_timeouts. NumOfTimeouts *int32 `json:"num_of_timeouts,omitempty"` }
GslbSiteRuntimeStats gslb site runtime stats swagger:model GslbSiteRuntimeStats
type GslbStatus ¶
type GslbStatus struct { // details of GslbStatus. Details []string `json:"details,omitempty"` // Placeholder for description of property gslb_runtime of obj type GslbStatus field type str type object GslbRuntime *GslbRuntime `json:"gslb_runtime,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Field introduced in 17.2.5. Site *GslbSiteRuntime `json:"site,omitempty"` // Field introduced in 17.2.5. ThirdPartySite *GslbThirdPartySiteRuntime `json:"third_party_site,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
GslbStatus gslb status swagger:model GslbStatus
type GslbSubDomainPlacementRuntime ¶
type GslbSubDomainPlacementRuntime struct { // This field describes the placement status of fqdns mapping to the above Subdomain. If placement allowed is true, then the fqdn/GslbService will be placed on the DNS-VS. Otherwise, it shall not be placed on the DNS-VS. . Field introduced in 17.2.3. PlacementAllowed *bool `json:"placement_allowed,omitempty"` // This field identifies the Subdomain. Field introduced in 17.2.3. SubDomain *string `json:"sub_domain,omitempty"` // This field describes the transition operation to be initiated downstream when subdomain placement rules change. For example if a.com was not placed on dns-vs-1 and due to configuration change if it is to be placed on dns-vs-1, then all the GslbServices whose fqdn maps a.com will be pushed to dns-vs-1. In this scenario, the transition ops will be GSLB_CREATE. If there is a configuration change where a.com is not placed on dns-vs-1 then the transition ops will be GSLB_DELETE. . Enum options - GSLB_NONE, GSLB_CREATE, GSLB_UPDATE, GSLB_DELETE, GSLB_PURGE, GSLB_DECL. Field introduced in 17.2.3. TransitionOps *string `json:"transition_ops,omitempty"` }
GslbSubDomainPlacementRuntime gslb sub domain placement runtime swagger:model GslbSubDomainPlacementRuntime
type GslbThirdPartySite ¶
type GslbThirdPartySite struct { // Third-party-site identifier generated by Avi. Field introduced in 17.1.1. // Read Only: true ClusterUUID *string `json:"cluster_uuid,omitempty"` // Enable or disable the third-party Site. This is useful in maintenance scenarios such as upgrade and routine maintenance. A disabled site's configuration shall be retained but it will not get any new configuration updates. VIPs associated with the disabled site shall not be sent in DNS response. . Field introduced in 17.1.1. Enabled *bool `json:"enabled,omitempty"` // User can designate certain Avi sites to run health monitor probes for VIPs/VS(es) for this site. This is useful in network deployments where the VIPs/VS(es) are reachable only from certain sites. A typical scenario is a firewall between two GSLB sites. User may want to run health monitor probes from sites on either side of the firewall so that each designated site can derive a datapath view of the reachable members. If the health monitor proxies are not configured, then the default behavior is to run health monitor probes from all the active sites. Field introduced in 17.1.1. HmProxies []*GslbHealthMonitorProxy `json:"hm_proxies,omitempty"` // Geographic location of the site. Field introduced in 17.1.1. Location *GslbGeoLocation `json:"location,omitempty"` // Name of the third-party Site. Field introduced in 17.1.1. // Required: true Name *string `json:"name"` // User can overide the individual GslbPoolMember ratio for all the VIPs of this site. If this field is not configured, then the GslbPoolMember ratio gets applied. . Allowed values are 1-20. Field introduced in 17.1.1. Ratio *int32 `json:"ratio,omitempty"` // This field is used as a key in the datastore for the GslbThirdPartySite table to encapsulate site-related info. . Field introduced in 17.2.5. UUID *string `json:"uuid,omitempty"` }
GslbThirdPartySite gslb third party site swagger:model GslbThirdPartySite
type GslbThirdPartySiteRuntime ¶
type GslbThirdPartySiteRuntime struct { // Field introduced in 17.1.1. SiteInfo *GslbSiteRuntimeInfo `json:"site_info,omitempty"` }
GslbThirdPartySiteRuntime gslb third party site runtime swagger:model GslbThirdPartySiteRuntime
type HSMAwsCloudHsm ¶
type HSMAwsCloudHsm struct { // Field introduced in 17.2.7. // Read Only: true ClientConfig *string `json:"client_config,omitempty"` // AWS CloudHSM Cluster Certificate. Field introduced in 17.2.7. ClusterCert *string `json:"cluster_cert,omitempty"` // Username of the Crypto User. This will be used to access the keys on the HSM . Field introduced in 17.2.7. CryptoUserName *string `json:"crypto_user_name,omitempty"` // Password of the Crypto User. This will be used to access the keys on the HSM . Field introduced in 17.2.7. CryptoUserPassword *string `json:"crypto_user_password,omitempty"` // IP address of the HSM in the cluster. If there are more than one HSMs, only one is sufficient. Field introduced in 17.2.7. HsmIP []string `json:"hsm_ip,omitempty"` // Field introduced in 17.2.7. // Read Only: true MgmtConfig *string `json:"mgmt_config,omitempty"` }
HSMAwsCloudHsm h s m aws cloud hsm swagger:model HSMAwsCloudHsm
type HSMSafenetClientInfo ¶
type HSMSafenetClientInfo struct { // Generated File - Chrystoki.conf . ChrystokiConf *string `json:"chrystoki_conf,omitempty"` // Client Certificate generated by createCert. ClientCert *string `json:"client_cert,omitempty"` // Name prepended to client key and certificate filename. // Required: true ClientIP *string `json:"client_ip"` // Client Private Key generated by createCert. ClientPrivKey *string `json:"client_priv_key,omitempty"` // Major number of the sesseion. SessionMajorNumber *int32 `json:"session_major_number,omitempty"` // Minor number of the sesseion. SessionMinorNumber *int32 `json:"session_minor_number,omitempty"` }
HSMSafenetClientInfo h s m safenet client info swagger:model HSMSafenetClientInfo
type HSMSafenetLuna ¶
type HSMSafenetLuna struct { // Group Number of generated HA Group. HaGroupNum *int64 `json:"ha_group_num,omitempty"` // Set to indicate HA across more than one servers. // Required: true IsHa *bool `json:"is_ha"` // Node specific information. NodeInfo []*HSMSafenetClientInfo `json:"node_info,omitempty"` // SafeNet/Gemalto HSM Servers used for crypto operations. Server []*HSMSafenetLunaServer `json:"server,omitempty"` // Generated File - server.pem. ServerPem *string `json:"server_pem,omitempty"` // If enabled, dedicated network is used to communicate with HSM,else, the management network is used. UseDedicatedNetwork *bool `json:"use_dedicated_network,omitempty"` }
HSMSafenetLuna h s m safenet luna swagger:model HSMSafenetLuna
type HSMSafenetLunaServer ¶
type HSMSafenetLunaServer struct { // Field introduced in 16.5.2,17.2.3. // Required: true Index *int32 `json:"index"` // Password of the partition assigned to this client. PartitionPasswd *string `json:"partition_passwd,omitempty"` // Serial number of the partition assigned to this client. Field introduced in 16.5.2,17.2.3. PartitionSerialNumber *string `json:"partition_serial_number,omitempty"` // IP address of the Safenet/Gemalto HSM device. // Required: true RemoteIP *string `json:"remote_ip"` // CA certificate of the server. // Required: true ServerCert *string `json:"server_cert"` }
HSMSafenetLunaServer h s m safenet luna server swagger:model HSMSafenetLunaServer
type HSMThalesNetHsm ¶
type HSMThalesNetHsm struct { // Electronic serial number of the netHSM device. Use Thales anonkneti utility to find the netHSM ESN. // Required: true Esn *string `json:"esn"` // Hash of the key that netHSM device uses to authenticate itself. Use Thales anonkneti utility to find the netHSM keyhash. // Required: true Keyhash *string `json:"keyhash"` // Local module id of the netHSM device. ModuleID *int32 `json:"module_id,omitempty"` // Priority class of the nethsm in an high availability setup. 1 is the highest priority and 100 is the lowest priority. Allowed values are 1-100. // Required: true Priority *int32 `json:"priority"` // IP address of the netHSM device. // Required: true RemoteIP *IPAddr `json:"remote_ip"` // Port at which the netHSM device accepts the connection. Allowed values are 1-65535. RemotePort *int32 `json:"remote_port,omitempty"` }
HSMThalesNetHsm h s m thales net hsm swagger:model HSMThalesNetHsm
type HSMThalesRFS ¶
type HSMThalesRFS struct { // IP address of the RFS server from where to sync the Thales encrypted private key. // Required: true IP *IPAddr `json:"ip"` // Port at which the RFS server accepts the sync request from clients for Thales encrypted private key. Allowed values are 1-65535. Port *int32 `json:"port,omitempty"` }
HSMThalesRFS h s m thales r f s swagger:model HSMThalesRFS
type HSMgrDebugFilter ¶
type HSMgrDebugFilter struct { // entity of HSMgrDebugFilter. Entity *string `json:"entity,omitempty"` // Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. MetricEntity *string `json:"metric_entity,omitempty"` // Number of period. Period *int32 `json:"period,omitempty"` // pool of HSMgrDebugFilter. Pool *string `json:"pool,omitempty"` // server of HSMgrDebugFilter. Server *string `json:"server,omitempty"` // Placeholder for description of property skip_hs_db_writes of obj type HSMgrDebugFilter field type str type boolean SkipHsDbWrites *bool `json:"skip_hs_db_writes,omitempty"` }
HSMgrDebugFilter h s mgr debug filter swagger:model HSMgrDebugFilter
type HTTPApplicationProfile ¶
type HTTPApplicationProfile struct { // Allow use of dot (.) in HTTP header names, for instance Header.app.special PickAppVersionX. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AllowDotsInHeaderName *bool `json:"allow_dots_in_header_name,omitempty"` // HTTP Caching config to use with this HTTP Profile. CacheConfig *HTTPCacheConfig `json:"cache_config,omitempty"` // The maximum length of time allowed between consecutive read operations for a client request body. The value '0' specifies no timeout. This setting generally impacts the length of time allowed for a client to send a POST. Allowed values are 0-100000000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 30000) edition, Essentials(Allowed values- 30000) edition, Enterprise edition. ClientBodyTimeout *int32 `json:"client_body_timeout,omitempty"` // The maximum length of time allowed for a client to transmit an entire request header. This helps mitigate various forms of SlowLoris attacks. Allowed values are 10-100000000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 10000) edition, Essentials(Allowed values- 10000) edition, Enterprise edition. ClientHeaderTimeout *int32 `json:"client_header_timeout,omitempty"` // Maximum size for the client request body. This limits the size of the client data that can be uploaded/posted as part of a single HTTP Request. Default 0 => Unlimited. Unit is KB. ClientMaxBodySize *int64 `json:"client_max_body_size,omitempty"` // Maximum size in Kbytes of a single HTTP header in the client request. Allowed values are 1-64. Unit is KB. Allowed in Basic(Allowed values- 12) edition, Essentials(Allowed values- 12) edition, Enterprise edition. ClientMaxHeaderSize *int32 `json:"client_max_header_size,omitempty"` // Maximum size in Kbytes of all the client HTTP request headers. Allowed values are 1-256. Unit is KB. ClientMaxRequestSize *int32 `json:"client_max_request_size,omitempty"` // HTTP Compression settings to use with this HTTP Profile. CompressionProfile *CompressionProfile `json:"compression_profile,omitempty"` // Allows HTTP requests, not just TCP connections, to be load balanced across servers. Proxied TCP connections to servers may be reused by multiple clients to improve performance. Not compatible with Preserve Client IP. ConnectionMultiplexingEnabled *bool `json:"connection_multiplexing_enabled,omitempty"` // Detect NTLM apps based on the HTTP Response from the server. Once detected, connection multiplexing will be disabled for that connection. Field introduced in 20.1.3. DetectNtlmApp *bool `json:"detect_ntlm_app,omitempty"` // Disable keep-alive client side connections for older browsers based off MS Internet Explorer 6.0 (MSIE6). For some applications, this might break NTLM authentication for older clients based off MSIE6. For such applications, set this option to false to allow keep-alive connections. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. DisableKeepalivePostsMsie6 *bool `json:"disable_keepalive_posts_msie6,omitempty"` // Disable strict check between TLS servername and HTTP Host name. Field introduced in 18.2.5. DisableSniHostnameCheck *bool `json:"disable_sni_hostname_check,omitempty"` // Enable chunk body merge for chunked transfer encoding response. Field introduced in 18.2.7. EnableChunkMerge *bool `json:"enable_chunk_merge,omitempty"` // Enable support for fire and forget feature. If enabled, request from client is forwarded to server even if client prematurely closes the connection. Field introduced in 17.2.4. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableFireAndForget *bool `json:"enable_fire_and_forget,omitempty"` // Enable request body buffering for POST requests. If enabled, max buffer size is set to lower of 32M or the value (non-zero) configured in client_max_body_size. EnableRequestBodyBuffering *bool `json:"enable_request_body_buffering,omitempty"` // Enable HTTP request body metrics. If enabled, requests from clients are parsed and relevant statistics about them are gathered. Currently, it processes HTTP POST requests with Content-Type application/x-www-form-urlencoded or multipart/form-data, and adds the number of detected parameters to the l7_client.http_params_count. This is an experimental feature and it may have performance impact. Use it when detailed information about the number of HTTP POST parameters is needed, e.g. for WAF sizing. Field introduced in 18.1.5, 18.2.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableRequestBodyMetrics *bool `json:"enable_request_body_metrics,omitempty"` // Forward the Connection Close header coming from backend server to the client if connection-switching is enabled, i.e. front-end and backend connections are bound together. Field introduced in 18.2.3. FwdCloseHdrForBoundConnections *bool `json:"fwd_close_hdr_for_bound_connections,omitempty"` // Inserts HTTP Strict-Transport-Security header in the HTTPS response. HSTS can help mitigate man-in-the-middle attacks by telling browsers that support HSTS that they should only access this site via HTTPS. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. HstsEnabled *bool `json:"hsts_enabled,omitempty"` // Number of days for which the client should regard this virtual service as a known HSTS host. Allowed values are 0-10000. Allowed in Basic(Allowed values- 365) edition, Essentials(Allowed values- 365) edition, Enterprise edition. HstsMaxAge *int64 `json:"hsts_max_age,omitempty"` // Insert the 'includeSubdomains' directive in the HTTP Strict-Transport-Security header. Adding the includeSubdomains directive signals the User-Agent that the HSTS Policy applies to this HSTS Host as well as any subdomains of the host's domain name. Field introduced in 17.2.13, 18.1.4, 18.2.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. HstsSubdomainsEnabled *bool `json:"hsts_subdomains_enabled,omitempty"` // Enable HTTP2 for traffic from clients to the virtual service. Field deprecated in 20.1.1. Field introduced in 18.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. Http2Enabled *bool `json:"http2_enabled,omitempty"` // Specifies the HTTP/2 specific application profile parameters. Field introduced in 18.2.10, 20.1.1. Allowed in Essentials edition, Enterprise edition. Http2Profile *Http2ApplicationProfile `json:"http2_profile,omitempty"` // Client requests received via HTTP will be redirected to HTTPS. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. HTTPToHTTPS *bool `json:"http_to_https,omitempty"` // Size of HTTP buffer in kB. Allowed values are 1-256. Special values are 0- 'Auto compute the size of buffer'. Field introduced in 20.1.1. Unit is KB. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. HTTPUpstreamBufferSize *int32 `json:"http_upstream_buffer_size,omitempty"` // Mark HTTP cookies as HTTPonly. This helps mitigate cross site scripting attacks as browsers will not allow these cookies to be read by third parties, such as javascript. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. HttponlyEnabled *bool `json:"httponly_enabled,omitempty"` // Send HTTP 'Keep-Alive' header to the client. By default, the timeout specified in the 'Keep-Alive Timeout' field will be used unless the 'Use App Keepalive Timeout' flag is set, in which case the timeout sent by the application will be honored. KeepaliveHeader *bool `json:"keepalive_header,omitempty"` // The max idle time allowed between HTTP requests over a Keep-alive connection. Allowed values are 10-100000000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 30000) edition, Essentials(Allowed values- 30000) edition, Enterprise edition. KeepaliveTimeout *int32 `json:"keepalive_timeout,omitempty"` // Maximum bad requests per second per client IP. Allowed values are 10-1000. Special values are 0- 'unlimited'. MaxBadRpsCip *int32 `json:"max_bad_rps_cip,omitempty"` // Maximum bad requests per second per client IP and URI. Allowed values are 10-1000. Special values are 0- 'unlimited'. MaxBadRpsCipURI *int32 `json:"max_bad_rps_cip_uri,omitempty"` // Maximum bad requests per second per URI. Allowed values are 10-1000. Special values are 0- 'unlimited'. MaxBadRpsURI *int32 `json:"max_bad_rps_uri,omitempty"` // The max number of concurrent streams over a client side HTTP/2 connection. Allowed values are 1-256. Field deprecated in 18.2.10, 20.1.1. Field introduced in 18.2.6. Allowed in Basic edition, Essentials edition, Enterprise edition. MaxHttp2ConcurrentStreamsPerConnection *int32 `json:"max_http2_concurrent_streams_per_connection,omitempty"` // The max number of control frames that client can send over an HTTP/2 connection. '0' means unlimited. Allowed values are 0-10000. Special values are 0- 'Unlimited control frames on a client side HTTP/2 connection'. Field deprecated in 18.2.10, 20.1.1. Field introduced in 18.2.6. Allowed in Basic edition, Essentials edition, Enterprise edition. MaxHttp2ControlFramesPerConnection *int32 `json:"max_http2_control_frames_per_connection,omitempty"` // The max number of empty data frames that client can send over an HTTP/2 connection. '0' means unlimited. Allowed values are 0-10000. Special values are 0- 'Unlimited empty data frames over a client side HTTP/2 connection'. Field deprecated in 18.2.10, 20.1.1. Field introduced in 18.2.6. Allowed in Basic edition, Essentials edition, Enterprise edition. MaxHttp2EmptyDataFramesPerConnection *int32 `json:"max_http2_empty_data_frames_per_connection,omitempty"` // The max number of frames that can be queued waiting to be sent over a client side HTTP/2 connection at any given time. '0' means unlimited. Allowed values are 0-10000. Special values are 0- 'Unlimited frames can be queued on a client side HTTP/2 connection'. Field deprecated in 18.2.10, 20.1.1. Field introduced in 18.2.6. Allowed in Basic edition, Essentials edition, Enterprise edition. MaxHttp2QueuedFramesToClientPerConnection *int32 `json:"max_http2_queued_frames_to_client_per_connection,omitempty"` // The max number of HTTP requests that can be sent over a Keep-Alive connection. '0' means unlimited. Allowed values are 0-1000000. Special values are 0- 'Unlimited requests on a connection'. Field introduced in 18.2.5. Allowed in Basic(Allowed values- 100) edition, Essentials(Allowed values- 100) edition, Enterprise edition. MaxKeepaliveRequests *int32 `json:"max_keepalive_requests,omitempty"` // Maximum size in Kbytes of all the HTTP response headers. Allowed values are 1-256. Unit is KB. Allowed in Basic(Allowed values- 48) edition, Essentials(Allowed values- 48) edition, Enterprise edition. MaxResponseHeadersSize *int32 `json:"max_response_headers_size,omitempty"` // Maximum requests per second per client IP. Allowed values are 10-1000. Special values are 0- 'unlimited'. MaxRpsCip *int32 `json:"max_rps_cip,omitempty"` // Maximum requests per second per client IP and URI. Allowed values are 10-1000. Special values are 0- 'unlimited'. MaxRpsCipURI *int32 `json:"max_rps_cip_uri,omitempty"` // Maximum unknown client IPs per second. Allowed values are 10-1000. Special values are 0- 'unlimited'. MaxRpsUnknownCip *int32 `json:"max_rps_unknown_cip,omitempty"` // Maximum unknown URIs per second. Allowed values are 10-1000. Special values are 0- 'unlimited'. MaxRpsUnknownURI *int32 `json:"max_rps_unknown_uri,omitempty"` // Maximum requests per second per URI. Allowed values are 10-1000. Special values are 0- 'unlimited'. MaxRpsURI *int32 `json:"max_rps_uri,omitempty"` // Select the PKI profile to be associated with the Virtual Service. This profile defines the Certificate Authority and Revocation List. It is a reference to an object of type PKIProfile. PkiProfileRef *string `json:"pki_profile_ref,omitempty"` // The max allowed length of time between a client establishing a TCP connection and Avi receives the first byte of the client's HTTP request. Allowed values are 10-100000000. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 30000) edition, Essentials(Allowed values- 30000) edition, Enterprise edition. PostAcceptTimeout *int32 `json:"post_accept_timeout,omitempty"` // If enabled, an HTTP request on an SSL port will result in connection close instead of a 400 response. Field introduced in 18.2.6. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ResetConnHTTPOnSslPort *bool `json:"reset_conn_http_on_ssl_port,omitempty"` // Avi will respond with 100-Continue response if Expect 100-Continue header received from client. Field introduced in 17.2.8. RespondWith100Continue *bool `json:"respond_with_100_continue,omitempty"` // Mark server cookies with the 'Secure' attribute. Client browsers will not send a cookie marked as secure over an unencrypted connection. If Avi is terminating SSL from clients and passing it as HTTP to the server, the server may return cookies without the secure flag set. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. SecureCookieEnabled *bool `json:"secure_cookie_enabled,omitempty"` // When terminating client SSL sessions at Avi, servers may incorrectly send redirect to clients as HTTP. This option will rewrite the server's redirect responses for this virtual service from HTTP to HTTPS. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ServerSideRedirectToHTTPS *bool `json:"server_side_redirect_to_https,omitempty"` // This field is deprecated. Field deprecated in 18.2.8. SpdyEnabled *bool `json:"spdy_enabled,omitempty"` // This field is deprecated. Field deprecated in 18.2.8. SpdyFwdProxyMode *bool `json:"spdy_fwd_proxy_mode,omitempty"` // Set of match/action rules that govern what happens when the client certificate request is enabled. SslClientCertificateAction *SSLClientCertificateAction `json:"ssl_client_certificate_action,omitempty"` // Specifies whether the client side verification is set to none, request or require. Enum options - SSL_CLIENT_CERTIFICATE_NONE, SSL_CLIENT_CERTIFICATE_REQUEST, SSL_CLIENT_CERTIFICATE_REQUIRE. Allowed in Basic(Allowed values- SSL_CLIENT_CERTIFICATE_NONE,SSL_CLIENT_CERTIFICATE_REQUIRE) edition, Essentials(Allowed values- SSL_CLIENT_CERTIFICATE_NONE,SSL_CLIENT_CERTIFICATE_REQUIRE) edition, Enterprise edition. SslClientCertificateMode *string `json:"ssl_client_certificate_mode,omitempty"` // Enable common settings to increase the level of security for virtual services running HTTP and HTTPS. For sites that are HTTP only, these settings will have no effect. Field deprecated in 18.2.7. SslEverywhereEnabled *bool `json:"ssl_everywhere_enabled,omitempty"` // Use 'Keep-Alive' header timeout sent by application instead of sending the HTTP Keep-Alive Timeout. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. UseAppKeepaliveTimeout *bool `json:"use_app_keepalive_timeout,omitempty"` // Enable Websockets proxy for traffic from clients to the virtual service. Connections to this VS start in HTTP mode. If the client requests an Upgrade to Websockets, and the server responds back with success, then the connection is upgraded to WebSockets mode. . WebsocketsEnabled *bool `json:"websockets_enabled,omitempty"` // Insert an X-Forwarded-Proto header in the request sent to the server. When the client connects via SSL, Avi terminates the SSL, and then forwards the requests to the servers via HTTP, so the servers can determine the original protocol via this header. In this example, the value will be 'https'. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. XForwardedProtoEnabled *bool `json:"x_forwarded_proto_enabled,omitempty"` // Provide a custom name for the X-Forwarded-For header sent to the servers. XffAlternateName *string `json:"xff_alternate_name,omitempty"` // The client's original IP address is inserted into an HTTP request header sent to the server. Servers may use this address for logging or other purposes, rather than Avi's source NAT address used in the Avi to server IP connection. XffEnabled *bool `json:"xff_enabled,omitempty"` }
HTTPApplicationProfile HTTP application profile swagger:model HTTPApplicationProfile
type HTTPCacheConfig ¶
type HTTPCacheConfig struct { // Add an Age header to content served from cache, which indicates to the client the number of seconds the object has been in the cache. AgeHeader *bool `json:"age_header,omitempty"` // Enable/disable caching objects without Cache-Control headers. Aggressive *bool `json:"aggressive,omitempty"` // If a Date header was not added by the server, add a Date header to the object served from cache. This indicates to the client when the object was originally sent by the server to the cache. DateHeader *bool `json:"date_header,omitempty"` // Default expiration time of cache objects received from the server without a Cache-Control expiration header. This value may be overwritten by the Heuristic Expire setting. DefaultExpire *int32 `json:"default_expire,omitempty"` // Enable/disable HTTP object caching.When enabling caching for the first time, SE Group app_cache_percent must be set to allocate shared memory required for caching (A service engine restart is needed after setting/resetting the SE group value). Enabled *bool `json:"enabled,omitempty"` // If a response object from the server does not include the Cache-Control header, but does include a Last-Modified header, the system will use this time to calculate the Cache-Control expiration. If unable to solicit an Last-Modified header, then the system will fall back to the Cache Expire Time value. HeuristicExpire *bool `json:"heuristic_expire,omitempty"` // Ignore client's cache control headers when fetching or storing from and to the cache. Field introduced in 18.1.2. IgnoreRequestCacheControl *bool `json:"ignore_request_cache_control,omitempty"` // Max size, in bytes, of the cache. The default, zero, indicates auto configuration. MaxCacheSize *int64 `json:"max_cache_size,omitempty"` // Maximum size of an object to store in the cache. MaxObjectSize *int32 `json:"max_object_size,omitempty"` // Blacklist *string group of non-cacheable mime types. It is a reference to an object of type StringGroup. Field deprecated in 20.1.3. MimeTypesBlackGroupRefs []string `json:"mime_types_black_group_refs,omitempty"` // Blacklist of non-cacheable mime types. Field deprecated in 20.1.3. MimeTypesBlackList []string `json:"mime_types_black_list,omitempty"` // Blocklist *string group of non-cacheable mime types. It is a reference to an object of type StringGroup. Field introduced in 20.1.3. MimeTypesBlockGroupRefs []string `json:"mime_types_block_group_refs,omitempty"` // Blocklist of non-cacheable mime types. Field introduced in 20.1.3. MimeTypesBlockLists []string `json:"mime_types_block_lists,omitempty"` // Allowlist *string group of cacheable mime types. If both Cacheable Mime Types *string list and *string group are empty, this defaults to */*. It is a reference to an object of type StringGroup. MimeTypesGroupRefs []string `json:"mime_types_group_refs,omitempty"` // Allowlist of cacheable mime types. If both Cacheable Mime Types *string list and *string group are empty, this defaults to */*. MimeTypesList []string `json:"mime_types_list,omitempty"` // Minimum size of an object to store in the cache. MinObjectSize *int32 `json:"min_object_size,omitempty"` // Allow caching of objects whose URI included a query argument. When disabled, these objects are not cached. When enabled, the request must match the URI query to be considered a hit. QueryCacheable *bool `json:"query_cacheable,omitempty"` // Non-cacheable URI configuration with match criteria. Field introduced in 18.1.2. URINonCacheable *PathMatch `json:"uri_non_cacheable,omitempty"` // Add an X-Cache header to content served from cache, which indicates to the client that the object was served from an intermediate cache. XcacheHeader *bool `json:"xcache_header,omitempty"` }
HTTPCacheConfig Http cache config swagger:model HttpCacheConfig
type HTTPCacheObjFilter ¶
type HTTPCacheObjFilter struct { // HTTP cache object's exact key. Key *string `json:"key,omitempty"` // HTTP cache object's exact raw key. RawKey *string `json:"raw_key,omitempty"` // HTTP cache object's resource name. ResourceName *string `json:"resource_name,omitempty"` // objects with resource type. ResourceType *string `json:"resource_type,omitempty"` // HTTP cache object type. Enum options - CO_ALL, CO_IN, CO_OUT. Type *string `json:"type,omitempty"` }
HTTPCacheObjFilter Http cache obj filter swagger:model HttpCacheObjFilter
type HTTPClientAuthenticationParams ¶
type HTTPClientAuthenticationParams struct { // Auth Profile to use for validating users. It is a reference to an object of type AuthProfile. AuthProfileRef *string `json:"auth_profile_ref,omitempty"` // Basic authentication realm to present to a user along with the prompt for credentials. Realm *string `json:"realm,omitempty"` // Rrequest URI path when the authentication applies. RequestURIPath *StringMatch `json:"request_uri_path,omitempty"` // type of client authentication. Enum options - HTTP_BASIC_AUTH. Type *string `json:"type,omitempty"` }
HTTPClientAuthenticationParams HTTP client authentication params swagger:model HTTPClientAuthenticationParams
type HTTPCookieData ¶
type HTTPCookieData struct { // Cookie name. Name *string `json:"name,omitempty"` // Cookie value. Value *string `json:"value,omitempty"` }
HTTPCookieData HTTP cookie data swagger:model HTTPCookieData
type HTTPCookiePersistenceKey ¶
type HTTPCookiePersistenceKey struct { // aes_key of HttpCookiePersistenceKey. AesKey *string `json:"aes_key,omitempty"` // hmac_key of HttpCookiePersistenceKey. HmacKey *string `json:"hmac_key,omitempty"` // name to use for cookie encryption. Name *string `json:"name,omitempty"` }
HTTPCookiePersistenceKey Http cookie persistence key swagger:model HttpCookiePersistenceKey
type HTTPCookiePersistenceProfile ¶
type HTTPCookiePersistenceProfile struct { // If no persistence cookie was received from the client, always send it. AlwaysSendCookie *bool `json:"always_send_cookie,omitempty"` // HTTP cookie name for cookie persistence. CookieName *string `json:"cookie_name,omitempty"` // Key name to use for cookie encryption. EncryptionKey *string `json:"encryption_key,omitempty"` // Placeholder for description of property key of obj type HttpCookiePersistenceProfile field type str type object Key []*HTTPCookiePersistenceKey `json:"key,omitempty"` // The maximum lifetime of any session cookie. No value or 'zero' indicates no timeout. Allowed values are 1-14400. Special values are 0- 'No Timeout'. Unit is MIN. Timeout *int32 `json:"timeout,omitempty"` }
HTTPCookiePersistenceProfile Http cookie persistence profile swagger:model HttpCookiePersistenceProfile
type HTTPHdrAction ¶
type HTTPHdrAction struct { // ADD A new header with the new value is added irrespective of the existence of an HTTP header of the given name. REPLACE A new header with the new value is added if no header of the given name exists, else existing headers with the given name are removed and a new header with the new value is added. REMOVE All the headers of the given name are removed. Enum options - HTTP_ADD_HDR, HTTP_REMOVE_HDR, HTTP_REPLACE_HDR. Allowed in Basic(Allowed values- HTTP_REMOVE_HDR,HTTP_REPLACE_HDR) edition, Essentials(Allowed values- HTTP_REMOVE_HDR,HTTP_REPLACE_HDR) edition, Enterprise edition. // Required: true Action *string `json:"action"` // Cookie information. Cookie *HTTPCookieData `json:"cookie,omitempty"` // HTTP header information. Hdr *HTTPHdrData `json:"hdr,omitempty"` }
HTTPHdrAction HTTP hdr action swagger:model HTTPHdrAction
type HTTPHdrData ¶
type HTTPHdrData struct { // HTTP header name. Name *string `json:"name,omitempty"` // HTTP header value. Value *HTTPHdrValue `json:"value,omitempty"` }
HTTPHdrData HTTP hdr data swagger:model HTTPHdrData
type HTTPHdrValue ¶
type HTTPHdrValue struct { // HTTP header value or variable representing an HTTP header. Val *string `json:"val,omitempty"` // Variable. Enum options - HTTP_POLICY_VAR_CLIENT_IP, HTTP_POLICY_VAR_VS_PORT, HTTP_POLICY_VAR_VS_IP, HTTP_POLICY_VAR_HTTP_HDR, HTTP_POLICY_VAR_SSL_CLIENT_FINGERPRINT, HTTP_POLICY_VAR_SSL_CLIENT_SERIAL, HTTP_POLICY_VAR_SSL_CLIENT_ISSUER, HTTP_POLICY_VAR_SSL_CLIENT_SUBJECT, HTTP_POLICY_VAR_SSL_CLIENT_RAW, HTTP_POLICY_VAR_SSL_PROTOCOL, HTTP_POLICY_VAR_SSL_SERVER_NAME, HTTP_POLICY_VAR_USER_NAME, HTTP_POLICY_VAR_SSL_CIPHER, HTTP_POLICY_VAR_REQUEST_ID. Var *string `json:"var,omitempty"` }
HTTPHdrValue HTTP hdr value swagger:model HTTPHdrValue
type HTTPLocalFile ¶
type HTTPLocalFile struct { // Mime-type of the content in the file. // Required: true ContentType *string `json:"content_type"` // File content to used in the local HTTP response body. // Required: true FileContent *string `json:"file_content"` }
HTTPLocalFile HTTP local file swagger:model HTTPLocalFile
type HTTPPolicies ¶
type HTTPPolicies struct { // UUID of the virtual service HTTP policy collection. It is a reference to an object of type HTTPPolicySet. // Required: true HTTPPolicySetRef *string `json:"http_policy_set_ref"` // Index of the virtual service HTTP policy collection. // Required: true Index *int32 `json:"index"` }
HTTPPolicies HTTP policies swagger:model HTTPPolicies
type HTTPPolicySet ¶
type HTTPPolicySet struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Checksum of cloud configuration for Pool. Internally set by cloud connector. CloudConfigCksum *string `json:"cloud_config_cksum,omitempty"` // Creator name. CreatedBy *string `json:"created_by,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Geo database. It is a reference to an object of type GeoDB. Field introduced in 21.1.1. GeoDbRef *string `json:"geo_db_ref,omitempty"` // HTTP request policy for the virtual service. HTTPRequestPolicy *HTTPRequestPolicy `json:"http_request_policy,omitempty"` // HTTP response policy for the virtual service. HTTPResponsePolicy *HTTPResponsePolicy `json:"http_response_policy,omitempty"` // HTTP security policy for the virtual service. HTTPSecurityPolicy *HttpsecurityPolicy `json:"http_security_policy,omitempty"` // IP reputation database. It is a reference to an object of type IPReputationDB. Field introduced in 20.1.3. IPReputationDbRef *string `json:"ip_reputation_db_ref,omitempty"` // Placeholder for description of property is_internal_policy of obj type HTTPPolicySet field type str type boolean IsInternalPolicy *bool `json:"is_internal_policy,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the HTTP Policy Set. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the HTTP Policy Set. UUID *string `json:"uuid,omitempty"` }
HTTPPolicySet HTTP policy set swagger:model HTTPPolicySet
type HTTPPolicySetAPIResponse ¶
type HTTPPolicySetAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*HTTPPolicySet `json:"results,omitempty"` }
HTTPPolicySetAPIResponse HTTP policy set Api response swagger:model HTTPPolicySetApiResponse
type HTTPRedirectAction ¶
type HTTPRedirectAction struct { // Add a query *string to the redirect URI. If keep_query is set, concatenates the add_string to the query of the incoming request. Field introduced in 21.1.1. AddString *string `json:"add_string,omitempty"` // Host config. Host *URIParam `json:"host,omitempty"` // Keep or drop the query of the incoming request URI in the redirected URI. KeepQuery *bool `json:"keep_query,omitempty"` // Path config. Path *URIParam `json:"path,omitempty"` // Port to which redirect the request. Allowed values are 1-65535. Port *int32 `json:"port,omitempty"` // Protocol type. Enum options - HTTP, HTTPS. // Required: true Protocol *string `json:"protocol"` // HTTP redirect status code. Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307. StatusCode *string `json:"status_code,omitempty"` }
HTTPRedirectAction HTTP redirect action swagger:model HTTPRedirectAction
type HTTPRequestPolicy ¶
type HTTPRequestPolicy struct { // Add rules to the HTTP request policy. Rules []*HTTPRequestRule `json:"rules,omitempty"` }
HTTPRequestPolicy HTTP request policy swagger:model HTTPRequestPolicy
type HTTPRequestRule ¶
type HTTPRequestRule struct { // Log all HTTP headers upon rule match. AllHeaders *bool `json:"all_headers,omitempty"` // Enable or disable the rule. // Required: true Enable *bool `json:"enable"` // HTTP header rewrite action. HdrAction []*HTTPHdrAction `json:"hdr_action,omitempty"` // Index of the rule. // Required: true Index *int32 `json:"index"` // Log HTTP request upon rule match. Log *bool `json:"log,omitempty"` // Add match criteria to the rule. Match *MatchTarget `json:"match,omitempty"` // Name of the rule. // Required: true Name *string `json:"name"` // HTTP redirect action. RedirectAction *HTTPRedirectAction `json:"redirect_action,omitempty"` // HTTP request URL rewrite action. RewriteURLAction *HTTPRewriteURLAction `json:"rewrite_url_action,omitempty"` // Content switching action. SwitchingAction *HttpswitchingAction `json:"switching_action,omitempty"` }
HTTPRequestRule HTTP request rule swagger:model HTTPRequestRule
type HTTPReselectRespCode ¶
type HTTPReselectRespCode struct { // HTTP response code to be matched. Allowed values are 400-599. Codes []int64 `json:"codes,omitempty,omitempty"` // HTTP response code ranges to match. Ranges []*HttpstatusRange `json:"ranges,omitempty"` // Block of HTTP response codes to match for server reselect. Enum options - HTTP_RSP_4XX, HTTP_RSP_5XX. RespCodeBlock []string `json:"resp_code_block,omitempty"` }
HTTPReselectRespCode HTTP reselect resp code swagger:model HTTPReselectRespCode
type HTTPResponsePolicy ¶
type HTTPResponsePolicy struct { // Add rules to the HTTP response policy. Rules []*HTTPResponseRule `json:"rules,omitempty"` }
HTTPResponsePolicy HTTP response policy swagger:model HTTPResponsePolicy
type HTTPResponseRule ¶
type HTTPResponseRule struct { // Log all HTTP headers upon rule match. AllHeaders *bool `json:"all_headers,omitempty"` // Enable or disable the rule. // Required: true Enable *bool `json:"enable"` // HTTP header rewrite action. HdrAction []*HTTPHdrAction `json:"hdr_action,omitempty"` // Index of the rule. // Required: true Index *int32 `json:"index"` // Location header rewrite action. LocHdrAction *HTTPRewriteLocHdrAction `json:"loc_hdr_action,omitempty"` // Log HTTP request upon rule match. Log *bool `json:"log,omitempty"` // Add match criteria to the rule. Match *ResponseMatchTarget `json:"match,omitempty"` // Name of the rule. // Required: true Name *string `json:"name"` }
HTTPResponseRule HTTP response rule swagger:model HTTPResponseRule
type HTTPRewriteLocHdrAction ¶
type HTTPRewriteLocHdrAction struct { // Host config. Host *URIParam `json:"host,omitempty"` // Keep or drop the query from the server side redirect URI. KeepQuery *bool `json:"keep_query,omitempty"` // Path config. Path *URIParam `json:"path,omitempty"` // Port to use in the redirected URI. Allowed values are 1-65535. Port *int32 `json:"port,omitempty"` // HTTP protocol type. Enum options - HTTP, HTTPS. // Required: true Protocol *string `json:"protocol"` }
HTTPRewriteLocHdrAction HTTP rewrite loc hdr action swagger:model HTTPRewriteLocHdrAction
type HTTPRewriteURLAction ¶
type HTTPRewriteURLAction struct { // Host config. HostHdr *URIParam `json:"host_hdr,omitempty"` // Path config. Path *URIParam `json:"path,omitempty"` // Query config. Query *URIParamQuery `json:"query,omitempty"` }
HTTPRewriteURLAction HTTP rewrite URL action swagger:model HTTPRewriteURLAction
type HTTPVersionMatch ¶
type HTTPVersionMatch struct { // Criterion to use for HTTP version matching the version used in the HTTP request. Enum options - IS_IN, IS_NOT_IN. // Required: true MatchCriteria *string `json:"match_criteria"` // HTTP protocol version. Enum options - ZERO_NINE, ONE_ZERO, ONE_ONE, TWO_ZERO. Minimum of 1 items required. Maximum of 8 items allowed. Allowed in Basic(Allowed values- ONE_ZERO,ONE_ONE) edition, Essentials(Allowed values- ONE_ZERO,ONE_ONE) edition, Enterprise edition. Versions []string `json:"versions,omitempty"` }
HTTPVersionMatch HTTP version match swagger:model HTTPVersionMatch
type HardwareSecurityModule ¶
type HardwareSecurityModule struct { // AWS CloudHSM specific configuration. Field introduced in 17.2.7. Cloudhsm *HSMAwsCloudHsm `json:"cloudhsm,omitempty"` // Thales netHSM specific configuration. Nethsm []*HSMThalesNetHsm `json:"nethsm,omitempty"` // Thales Remote File Server (RFS), used for the netHSMs, configuration. Rfs *HSMThalesRFS `json:"rfs,omitempty"` // Safenet/Gemalto Luna/Gem specific configuration. Sluna *HSMSafenetLuna `json:"sluna,omitempty"` // HSM type to use. Enum options - HSM_TYPE_THALES_NETHSM, HSM_TYPE_SAFENET_LUNA, HSM_TYPE_AWS_CLOUDHSM. // Required: true Type *string `json:"type"` }
HardwareSecurityModule hardware security module swagger:model HardwareSecurityModule
type HardwareSecurityModuleGroup ¶
type HardwareSecurityModuleGroup struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Hardware Security Module configuration. // Required: true Hsm *HardwareSecurityModule `json:"hsm"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the HSM Group configuration object. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the HSM Group configuration object. UUID *string `json:"uuid,omitempty"` }
HardwareSecurityModuleGroup hardware security module group swagger:model HardwareSecurityModuleGroup
type HardwareSecurityModuleGroupAPIResponse ¶
type HardwareSecurityModuleGroupAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*HardwareSecurityModuleGroup `json:"results,omitempty"` }
HardwareSecurityModuleGroupAPIResponse hardware security module group Api response swagger:model HardwareSecurityModuleGroupApiResponse
type HdrMatch ¶
type HdrMatch struct { // Name of the HTTP header whose value is to be matched. // Required: true Hdr *string `json:"hdr"` // Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. MatchCase *string `json:"match_case,omitempty"` // Criterion to use for matching headers in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL. // Required: true MatchCriteria *string `json:"match_criteria"` // String values to match in the HTTP header. Value []string `json:"value,omitempty"` }
HdrMatch hdr match swagger:model HdrMatch
type HdrPersistenceProfile ¶
type HdrPersistenceProfile struct { // Header name for custom header persistence. PrstHdrName *string `json:"prst_hdr_name,omitempty"` }
HdrPersistenceProfile hdr persistence profile swagger:model HdrPersistenceProfile
type HealthMonitor ¶
type HealthMonitor struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // By default, multiple instances of the same healthmonitor to the same server are suppressed intelligently. In rare cases, the monitor may have specific constructs that go beyond the server keys (ip, port, etc.) during which such suppression is not desired. Use this knob to allow duplicates. Field introduced in 18.2.8. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. AllowDuplicateMonitors *bool `json:"allow_duplicate_monitors,omitempty"` // Authentication information for username/password. Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. Authentication *HealthMonitorAuthInfo `json:"authentication,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // During addition of a server or healthmonitors or during bootup, Avi performs sequential health checks rather than waiting for send-interval to kick in, to mark the server up as soon as possible. This knob may be used to turn this feature off. Field introduced in 18.2.7. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. DisableQuickstart *bool `json:"disable_quickstart,omitempty"` // Placeholder for description of property dns_monitor of obj type HealthMonitor field type str type object DNSMonitor *HealthMonitorDNS `json:"dns_monitor,omitempty"` // Placeholder for description of property external_monitor of obj type HealthMonitor field type str type object ExternalMonitor *HealthMonitorExternal `json:"external_monitor,omitempty"` // Number of continuous failed health checks before the server is marked down. Allowed values are 1-50. FailedChecks *int32 `json:"failed_checks,omitempty"` // Placeholder for description of property http_monitor of obj type HealthMonitor field type str type object HTTPMonitor *HealthMonitorHTTP `json:"http_monitor,omitempty"` // Placeholder for description of property https_monitor of obj type HealthMonitor field type str type object HTTPSMonitor *HealthMonitorHTTP `json:"https_monitor,omitempty"` // Health monitor for IMAP. Field introduced in 21.1.1. ImapMonitor *HealthMonitorImap `json:"imap_monitor,omitempty"` // Health monitor for IMAPS. Field introduced in 21.1.1. ImapsMonitor *HealthMonitorImap `json:"imaps_monitor,omitempty"` // This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. . Field introduced in 17.1.3. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. IsFederated *bool `json:"is_federated,omitempty"` // Use this port instead of the port defined for the server in the Pool. If the monitor succeeds to this port, the load balanced traffic will still be sent to the port of the server defined within the Pool. Allowed values are 1-65535. Special values are 0 - 'Use server port'. MonitorPort *int32 `json:"monitor_port,omitempty"` // A user friendly name for this health monitor. // Required: true Name *string `json:"name"` // Health monitor for POP3. Field introduced in 21.1.1. Pop3Monitor *HealthMonitorPop3 `json:"pop3_monitor,omitempty"` // Health monitor for POP3S. Field introduced in 21.1.1. Pop3sMonitor *HealthMonitorPop3 `json:"pop3s_monitor,omitempty"` // Health monitor for Radius. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. RadiusMonitor *HealthMonitorRadius `json:"radius_monitor,omitempty"` // A valid response from the server is expected within the receive timeout window. This timeout must be less than the send interval. If server status is regularly flapping up and down, consider increasing this value. Allowed values are 1-2400. Unit is SEC. ReceiveTimeout *int32 `json:"receive_timeout,omitempty"` // Frequency, in seconds, that monitors are sent to a server. Allowed values are 1-3600. Unit is SEC. SendInterval *int32 `json:"send_interval,omitempty"` // Health monitor for SIP. Field introduced in 17.2.8, 18.1.3, 18.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. SipMonitor *HealthMonitorSIP `json:"sip_monitor,omitempty"` // Health monitor for SMTP. Field introduced in 21.1.1. SMTPMonitor *HealthMonitorSMTP `json:"smtp_monitor,omitempty"` // Health monitor for SMTPS. Field introduced in 21.1.1. SmtpsMonitor *HealthMonitorSMTP `json:"smtps_monitor,omitempty"` // Number of continuous successful health checks before server is marked up. Allowed values are 1-50. SuccessfulChecks *int32 `json:"successful_checks,omitempty"` // Placeholder for description of property tcp_monitor of obj type HealthMonitor field type str type object TCPMonitor *HealthMonitorTCP `json:"tcp_monitor,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Type of the health monitor. Enum options - HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP, HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB, HEALTH_MONITOR_SIP, HEALTH_MONITOR_RADIUS, HEALTH_MONITOR_SMTP, HEALTH_MONITOR_SMTPS, HEALTH_MONITOR_POP3, HEALTH_MONITOR_POP3S, HEALTH_MONITOR_IMAP, HEALTH_MONITOR_IMAPS. Allowed in Basic(Allowed values- HEALTH_MONITOR_PING,HEALTH_MONITOR_TCP,HEALTH_MONITOR_UDP,HEALTH_MONITOR_HTTP,HEALTH_MONITOR_HTTPS) edition, Essentials(Allowed values- HEALTH_MONITOR_PING,HEALTH_MONITOR_TCP,HEALTH_MONITOR_UDP) edition, Enterprise edition. // Required: true Type *string `json:"type"` // Placeholder for description of property udp_monitor of obj type HealthMonitor field type str type object UDPMonitor *HealthMonitorUDP `json:"udp_monitor,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the health monitor. UUID *string `json:"uuid,omitempty"` }
HealthMonitor health monitor swagger:model HealthMonitor
type HealthMonitorAPIResponse ¶
type HealthMonitorAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*HealthMonitor `json:"results,omitempty"` }
HealthMonitorAPIResponse health monitor Api response swagger:model HealthMonitorApiResponse
type HealthMonitorAuthInfo ¶
type HealthMonitorAuthInfo struct { // Password for server authentication. Field introduced in 20.1.1. // Required: true Password *string `json:"password"` // Username for server authentication. Field introduced in 20.1.1. // Required: true Username *string `json:"username"` }
HealthMonitorAuthInfo health monitor auth info swagger:model HealthMonitorAuthInfo
type HealthMonitorDNS ¶
type HealthMonitorDNS struct { // Query_Type Response has atleast one answer of which the resource record type matches the query type Any_Type Response should contain atleast one answer AnyThing An empty answer is enough. Enum options - DNS_QUERY_TYPE, DNS_ANY_TYPE, DNS_ANY_THING. Qtype *string `json:"qtype,omitempty"` // The DNS monitor will query the DNS server for the fully qualified name in this field. // Required: true QueryName *string `json:"query_name"` // When No Error is selected, a DNS query will be marked failed is any error code is returned by the server. With Any selected, the monitor ignores error code in the responses. Enum options - RCODE_NO_ERROR, RCODE_ANYTHING. Rcode *string `json:"rcode,omitempty"` // Resource record type used in the healthmonitor DNS query, only A or AAAA type supported. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Field introduced in 18.2.5. RecordType *string `json:"record_type,omitempty"` // The resource record of the queried DNS server's response for the Request Name must include the IP address defined in this field. . ResponseString *string `json:"response_string,omitempty"` }
HealthMonitorDNS health monitor DNS swagger:model HealthMonitorDNS
type HealthMonitorExternal ¶
type HealthMonitorExternal struct { // Command script provided inline. // Required: true CommandCode *string `json:"command_code"` // Optional arguments to feed into the script. CommandParameters *string `json:"command_parameters,omitempty"` // Path of external health monitor script. CommandPath *string `json:"command_path,omitempty"` // Environment variables to be fed into the script. CommandVariables *string `json:"command_variables,omitempty"` }
HealthMonitorExternal health monitor external swagger:model HealthMonitorExternal
type HealthMonitorHTTP ¶
type HealthMonitorHTTP struct { // Type of the authentication method. Enum options - AUTH_BASIC, AUTH_NTLM. Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. AuthType *string `json:"auth_type,omitempty"` // Use the exact http_request *string as specified by user, without any automatic insert of headers like Host header. Field introduced in 17.1.6,17.2.2. ExactHTTPRequest *bool `json:"exact_http_request,omitempty"` // Send an HTTP request to the server. The default GET / HTTP/1.0 may be extended with additional headers or information. For instance, GET /index.htm HTTP/1.1 Host www.site.com Connection Close. HTTPRequest *string `json:"http_request,omitempty"` // HTTP request body. Field introduced in 20.1.1. HTTPRequestBody *string `json:"http_request_body,omitempty"` // Match for a keyword in the first 2Kb of the server header and body response. HTTPResponse *string `json:"http_response,omitempty"` // List of HTTP response codes to match as successful. Default is 2xx. Enum options - HTTP_ANY, HTTP_1XX, HTTP_2XX, HTTP_3XX, HTTP_4XX, HTTP_5XX. Minimum of 1 items required. HTTPResponseCode []string `json:"http_response_code,omitempty"` // Match or look for this HTTP response code indicating server maintenance. A successful match results in the server being marked down. Allowed values are 101-599. Maximum of 4 items allowed. MaintenanceCode []int64 `json:"maintenance_code,omitempty,omitempty"` // Match or look for this keyword in the first 2KB of server header and body response indicating server maintenance. A successful match results in the server being marked down. MaintenanceResponse *string `json:"maintenance_response,omitempty"` // Expected http/https response page size. Allowed values are 2048-16384. Field introduced in 20.1.1. ResponseSize *int32 `json:"response_size,omitempty"` // SSL attributes for HTTPS health monitor. Field introduced in 17.1.1. SslAttributes *HealthMonitorSSlattributes `json:"ssl_attributes,omitempty"` }
HealthMonitorHTTP health monitor Http swagger:model HealthMonitorHttp
type HealthMonitorImap ¶
type HealthMonitorImap struct { // Folder to access. Field introduced in 21.1.1. Folder *string `json:"folder,omitempty"` // SSL attributes for IMAPS monitor. Field introduced in 21.1.1. SslAttributes *HealthMonitorSSlattributes `json:"ssl_attributes,omitempty"` }
HealthMonitorImap health monitor imap swagger:model HealthMonitorImap
type HealthMonitorPop3 ¶
type HealthMonitorPop3 struct { // SSL attributes for POP3S monitor. Field introduced in 21.1.1. SslAttributes *HealthMonitorSSlattributes `json:"ssl_attributes,omitempty"` }
HealthMonitorPop3 health monitor pop3 swagger:model HealthMonitorPop3
type HealthMonitorRadius ¶
type HealthMonitorRadius struct { // Radius monitor will query Radius server with this password. Field introduced in 18.2.3. // Required: true Password *string `json:"password"` // Required: true SharedSecret *string `json:"shared_secret"` // Radius monitor will query Radius server with this username. Field introduced in 18.2.3. // Required: true Username *string `json:"username"` }
HealthMonitorRadius health monitor radius swagger:model HealthMonitorRadius
type HealthMonitorSIP ¶
type HealthMonitorSIP struct { // Specify the transport protocol TCP or UDP, to be used for SIP health monitor. The default transport is UDP. Enum options - SIP_UDP_PROTO, SIP_TCP_PROTO. Field introduced in 17.2.14, 18.1.5, 18.2.1. SipMonitorTransport *string `json:"sip_monitor_transport,omitempty"` // Specify the SIP request to be sent to the server. By default, SIP OPTIONS request will be sent. Enum options - SIP_OPTIONS. Field introduced in 17.2.8, 18.1.3, 18.2.1. SipRequestCode *string `json:"sip_request_code,omitempty"` // Match for a keyword in the first 2KB of the server header and body response. By default, it matches for SIP/2.0. Field introduced in 17.2.8, 18.1.3, 18.2.1. SipResponse *string `json:"sip_response,omitempty"` }
HealthMonitorSIP health monitor s IP swagger:model HealthMonitorSIP
type HealthMonitorSMTP ¶
type HealthMonitorSMTP struct { // Sender domain name. Field introduced in 21.1.1. Domainname *string `json:"domainname,omitempty"` // Mail data. Field introduced in 21.1.1. MailData *string `json:"mail_data,omitempty"` // Mail recipients. Field introduced in 21.1.1. RecipientsIds []string `json:"recipients_ids,omitempty"` // Mail sender. Field introduced in 21.1.1. SenderID *string `json:"sender_id,omitempty"` // SSL attributes for SMTPS monitor. Field introduced in 21.1.1. SslAttributes *HealthMonitorSSlattributes `json:"ssl_attributes,omitempty"` }
HealthMonitorSMTP health monitor Smtp swagger:model HealthMonitorSmtp
type HealthMonitorSSlattributes ¶
type HealthMonitorSSlattributes struct { // PKI profile used to validate the SSL certificate presented by a server. It is a reference to an object of type PKIProfile. Field introduced in 17.1.1. PkiProfileRef *string `json:"pki_profile_ref,omitempty"` // Fully qualified DNS hostname which will be used in the TLS SNI extension in server connections indicating SNI is enabled. Field introduced in 18.2.3. ServerName *string `json:"server_name,omitempty"` // Service engines will present this SSL certificate to the server. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 17.1.1. SslKeyAndCertificateRef *string `json:"ssl_key_and_certificate_ref,omitempty"` // SSL profile defines ciphers and SSL versions to be used for healthmonitor traffic to the back-end servers. It is a reference to an object of type SSLProfile. Field introduced in 17.1.1. // Required: true SslProfileRef *string `json:"ssl_profile_ref"` }
HealthMonitorSSlattributes health monitor s slattributes swagger:model HealthMonitorSSLAttributes
type HealthMonitorTCP ¶
type HealthMonitorTCP struct { // Match or look for this keyword in the first 2KB of server's response indicating server maintenance. A successful match results in the server being marked down. MaintenanceResponse *string `json:"maintenance_response,omitempty"` // Configure TCP health monitor to use half-open TCP connections to monitor the health of backend servers thereby avoiding consumption of a full fledged server side connection and the overhead and logs associated with it. This method is light-weight as it makes use of listener in server's kernel layer to measure the health and a child socket or user thread is not created on the server side. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. TCPHalfOpen *bool `json:"tcp_half_open,omitempty"` // Request data to send after completing the TCP handshake. TCPRequest *string `json:"tcp_request,omitempty"` // Match for the desired keyword in the first 2Kb of the server's TCP response. If this field is left blank, no server response is required. TCPResponse *string `json:"tcp_response,omitempty"` }
HealthMonitorTCP health monitor Tcp swagger:model HealthMonitorTcp
type HealthMonitorUDP ¶
type HealthMonitorUDP struct { // Match or look for this keyword in the first 2KB of server's response indicating server maintenance. A successful match results in the server being marked down. MaintenanceResponse *string `json:"maintenance_response,omitempty"` // Send UDP request. UDPRequest *string `json:"udp_request,omitempty"` // Match for keyword in the UDP response. UDPResponse *string `json:"udp_response,omitempty"` }
HealthMonitorUDP health monitor Udp swagger:model HealthMonitorUdp
type HealthScoreDetails ¶
type HealthScoreDetails struct { // Number of anomaly_penalty. AnomalyPenalty *int32 `json:"anomaly_penalty,omitempty"` // Reason for Anomaly Penalty. AnomalyReason *string `json:"anomaly_reason,omitempty"` // Reason for Performance Score. PerformanceReason *string `json:"performance_reason,omitempty"` // Number of performance_score. PerformanceScore *int32 `json:"performance_score,omitempty"` // Placeholder for description of property previous_value of obj type HealthScoreDetails field type str type number // Required: true PreviousValue *float64 `json:"previous_value"` // Reason for the Health Score Change. Reason *string `json:"reason,omitempty"` // Number of resources_penalty. ResourcesPenalty *int32 `json:"resources_penalty,omitempty"` // Reason for Resources Penalty. ResourcesReason *string `json:"resources_reason,omitempty"` // Number of security_penalty. SecurityPenalty *int32 `json:"security_penalty,omitempty"` // Reason for Security Threat Level. SecurityReason *string `json:"security_reason,omitempty"` // The step interval in seconds. Step *int32 `json:"step,omitempty"` // Resource prefix containing entity information. SubResourcePrefix *string `json:"sub_resource_prefix,omitempty"` // timestamp of HealthScoreDetails. // Required: true Timestamp *string `json:"timestamp"` // Placeholder for description of property value of obj type HealthScoreDetails field type str type number // Required: true Value *float64 `json:"value"` }
HealthScoreDetails health score details swagger:model HealthScoreDetails
type HostAttributes ¶
type HostAttributes struct { // attr_key of HostAttributes. // Required: true AttrKey *string `json:"attr_key"` // attr_val of HostAttributes. AttrVal *string `json:"attr_val,omitempty"` }
HostAttributes host attributes swagger:model HostAttributes
type HostHdrMatch ¶
type HostHdrMatch struct { // Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. MatchCase *string `json:"match_case,omitempty"` // Criterion to use for the host header value match. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL. // Required: true MatchCriteria *string `json:"match_criteria"` // String value(s) in the host header. Value []string `json:"value,omitempty"` }
HostHdrMatch host hdr match swagger:model HostHdrMatch
type HostUnavailEventDetails ¶
type HostUnavailEventDetails struct { string `json:"name,omitempty"` Reasons []string `json:"reasons,omitempty"` VsName *string `json:"vs_name,omitempty"` }Name *
HostUnavailEventDetails host unavail event details swagger:model HostUnavailEventDetails
type Http2ApplicationProfile ¶
type Http2ApplicationProfile struct { // The initial flow control window size in KB for HTTP/2 streams. Allowed values are 64-32768. Field introduced in 18.2.10, 20.1.1. Unit is KB. Http2InitialWindowSize *int32 `json:"http2_initial_window_size,omitempty"` // The max number of concurrent streams over a client side HTTP/2 connection. Allowed values are 1-256. Field introduced in 18.2.10, 20.1.1. MaxHttp2ConcurrentStreamsPerConnection *int32 `json:"max_http2_concurrent_streams_per_connection,omitempty"` // The max number of control frames that client can send over an HTTP/2 connection. '0' means unlimited. Allowed values are 0-10000. Special values are 0- 'Unlimited control frames on a client side HTTP/2 connection'. Field introduced in 18.2.10, 20.1.1. MaxHttp2ControlFramesPerConnection *int32 `json:"max_http2_control_frames_per_connection,omitempty"` // The max number of empty data frames that client can send over an HTTP/2 connection. '0' means unlimited. Allowed values are 0-10000. Special values are 0- 'Unlimited empty data frames over a client side HTTP/2 connection'. Field introduced in 18.2.10, 20.1.1. MaxHttp2EmptyDataFramesPerConnection *int32 `json:"max_http2_empty_data_frames_per_connection,omitempty"` // The maximum size in bytes of the compressed request header field. The limit applies equally to both name and value. Allowed values are 1-8192. Field introduced in 18.2.10, 20.1.1. Unit is BYTES. MaxHttp2HeaderFieldSize *int32 `json:"max_http2_header_field_size,omitempty"` // The max number of frames that can be queued waiting to be sent over a client side HTTP/2 connection at any given time. '0' means unlimited. Allowed values are 0-10000. Special values are 0- 'Unlimited frames can be queued on a client side HTTP/2 connection'. Field introduced in 18.2.10, 20.1.1. MaxHttp2QueuedFramesToClientPerConnection *int32 `json:"max_http2_queued_frames_to_client_per_connection,omitempty"` // The maximum number of requests over a client side HTTP/2 connection. Allowed values are 0-10000. Special values are 0- 'Unlimited requests on a client side HTTP/2 connection'. Field introduced in 18.2.10, 20.1.1. MaxHttp2RequestsPerConnection *int32 `json:"max_http2_requests_per_connection,omitempty"` }
Http2ApplicationProfile http2 application profile swagger:model HTTP2ApplicationProfile
type HttpsecurityAction ¶
type HttpsecurityAction struct { // Type of the security action to perform. Enum options - HTTP_SECURITY_ACTION_CLOSE_CONN, HTTP_SECURITY_ACTION_SEND_RESPONSE, HTTP_SECURITY_ACTION_ALLOW, HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS, HTTP_SECURITY_ACTION_RATE_LIMIT, HTTP_SECURITY_ACTION_REQUEST_CHECK_ICAP. Allowed in Basic(Allowed values- HTTP_SECURITY_ACTION_CLOSE_CONN,HTTP_SECURITY_ACTION_SEND_RESPONSE,HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS) edition, Essentials(Allowed values- HTTP_SECURITY_ACTION_CLOSE_CONN,HTTP_SECURITY_ACTION_SEND_RESPONSE,HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS) edition, Enterprise edition. // Required: true Action *string `json:"action"` // File to be used for generating HTTP local response. File *HTTPLocalFile `json:"file,omitempty"` // Secure SSL/TLS port to redirect the HTTP request to. Allowed values are 1-65535. HTTPSPort *int32 `json:"https_port,omitempty"` // Rate Limit profile to be used to rate-limit the flow. (deprecated). Field deprecated in 18.2.9. RateLimit *RateProfile `json:"rate_limit,omitempty"` // Rate limiting configuration for this action. Field introduced in 18.2.9. Allowed in Basic edition, Essentials edition, Enterprise edition. RateProfile *HttpsecurityActionRateProfile `json:"rate_profile,omitempty"` // HTTP status code to use for local response. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501. StatusCode *string `json:"status_code,omitempty"` }
HttpsecurityAction httpsecurity action swagger:model HTTPSecurityAction
type HttpsecurityActionRateProfile ¶
type HttpsecurityActionRateProfile struct { // The action to take when the rate limit has been reached. Field introduced in 18.2.9. // Required: true Action *RateLimiterAction `json:"action"` // Rate limiting should be done on a per client ip basis. Field introduced in 18.2.9. PerClientIP *bool `json:"per_client_ip,omitempty"` // Rate limiting should be done on a per request uri path basis. Field introduced in 18.2.9. PerURIPath *bool `json:"per_uri_path,omitempty"` // The rate limiter used when this action is triggered. Field introduced in 18.2.9. // Required: true RateLimiter *RateLimiter `json:"rate_limiter"` }
HttpsecurityActionRateProfile httpsecurity action rate profile swagger:model HTTPSecurityActionRateProfile
type HttpsecurityPolicy ¶
type HttpsecurityPolicy struct { // Add rules to the HTTP security policy. Rules []*HttpsecurityRule `json:"rules,omitempty"` }
HttpsecurityPolicy httpsecurity policy swagger:model HTTPSecurityPolicy
type HttpsecurityRule ¶
type HttpsecurityRule struct { // Action to be performed upon successful matching. Action *HttpsecurityAction `json:"action,omitempty"` // Enable or disable the rule. // Required: true Enable *bool `json:"enable"` // Index of the rule. // Required: true Index *int32 `json:"index"` // Log HTTP request upon rule match. Log *bool `json:"log,omitempty"` // Add match criteria to the rule. Match *MatchTarget `json:"match,omitempty"` // Name of the rule. // Required: true Name *string `json:"name"` }
HttpsecurityRule httpsecurity rule swagger:model HTTPSecurityRule
type HttpserverReselect ¶
type HttpserverReselect struct { // Enable HTTP request reselect when server responds with specific response codes. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. // Required: true Enabled *bool `json:"enabled"` // Number of times to retry an HTTP request when server responds with configured status codes. NumRetries *int32 `json:"num_retries,omitempty"` // Allow retry of non-idempotent HTTP requests. RetryNonidempotent *bool `json:"retry_nonidempotent,omitempty"` // Timeout per retry attempt, for a given request. Value of 0 indicates default timeout. Allowed values are 0-3600000. Field introduced in 18.1.5,18.2.1. Unit is MILLISECONDS. RetryTimeout *int32 `json:"retry_timeout,omitempty"` // Server response codes which will trigger an HTTP request retry. SvrRespCode *HTTPReselectRespCode `json:"svr_resp_code,omitempty"` }
HttpserverReselect httpserver reselect swagger:model HTTPServerReselect
type HttpstatusMatch ¶
type HttpstatusMatch struct { // Criterion to use for matching the HTTP response status code(s). Enum options - IS_IN, IS_NOT_IN. // Required: true MatchCriteria *string `json:"match_criteria"` // HTTP response status code range(s). Ranges []*HttpstatusRange `json:"ranges,omitempty"` // HTTP response status code(s). StatusCodes []int64 `json:"status_codes,omitempty,omitempty"` }
HttpstatusMatch httpstatus match swagger:model HTTPStatusMatch
type HttpstatusRange ¶
type HttpstatusRange struct { // Starting HTTP response status code. // Required: true Begin *int32 `json:"begin"` // Ending HTTP response status code. // Required: true End *int32 `json:"end"` }
HttpstatusRange httpstatus range swagger:model HTTPStatusRange
type HttpswitchingAction ¶
type HttpswitchingAction struct { // Content switching action type. Enum options - HTTP_SWITCHING_SELECT_POOL, HTTP_SWITCHING_SELECT_LOCAL, HTTP_SWITCHING_SELECT_POOLGROUP. Allowed in Essentials(Allowed values- HTTP_SWITCHING_SELECT_POOL,HTTP_SWITCHING_SELECT_LOCAL) edition, Enterprise edition. // Required: true Action *string `json:"action"` // File from which to serve local response to the request. File *HTTPLocalFile `json:"file,omitempty"` // UUID of the pool group to serve the request. It is a reference to an object of type PoolGroup. PoolGroupRef *string `json:"pool_group_ref,omitempty"` // UUID of the pool of servers to serve the request. It is a reference to an object of type Pool. PoolRef *string `json:"pool_ref,omitempty"` // Specific pool server to select. Server *PoolServer `json:"server,omitempty"` // HTTP status code to use when serving local response. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501. StatusCode *string `json:"status_code,omitempty"` }
HttpswitchingAction httpswitching action swagger:model HTTPSwitchingAction
type HypervisorProperties ¶
type HypervisorProperties struct { // Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. // Required: true Htype *string `json:"htype"` // Number of max_ips_per_nic. MaxIpsPerNic *int32 `json:"max_ips_per_nic,omitempty"` // Number of max_nics. MaxNics *int32 `json:"max_nics,omitempty"` }
HypervisorProperties hypervisor properties swagger:model Hypervisor_Properties
type IPAMDNSAwsProfile ¶
type IPAMDNSAwsProfile struct { // AWS access key ID. AccessKeyID *string `json:"access_key_id,omitempty"` // A list of subnets used for source IP allocation for egress services in Openshift/k8s on Aws. Field introduced in 18.2.3. Maximum of 1 items allowed. EgressServiceSubnets []string `json:"egress_service_subnets,omitempty"` // IAM assume role for cross-account access. Field introduced in 17.1.1. IamAssumeRole *string `json:"iam_assume_role,omitempty"` // If enabled and the virtual service is not floating ip capable, vip will be published to both private and public zones. This flag is applicable only for AWS DNS profile. Field introduced in 17.2.10. PublishVipToPublicZone *bool `json:"publish_vip_to_public_zone,omitempty"` // AWS region. Region *string `json:"region,omitempty"` // AWS secret access key. SecretAccessKey *string `json:"secret_access_key,omitempty"` // Default TTL for all records. Allowed values are 1-172800. Field introduced in 17.1.3. Unit is SEC. TTL *int32 `json:"ttl,omitempty"` // Usable domains to pick from Amazon Route 53. Field introduced in 17.1.1. UsableDomains []string `json:"usable_domains,omitempty"` // Usable networks for Virtual IP. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation. Field introduced in 17.1.1. UsableNetworkUuids []string `json:"usable_network_uuids,omitempty"` // Use IAM roles instead of access and secret key. UseIamRoles *bool `json:"use_iam_roles,omitempty"` // VPC name. Vpc *string `json:"vpc,omitempty"` // VPC ID. // Required: true VpcID *string `json:"vpc_id"` // Network configuration for Virtual IP per AZ. Field introduced in 17.1.3. Zones []*AwsZoneNetwork `json:"zones,omitempty"` }
IPAMDNSAwsProfile ipam Dns aws profile swagger:model IpamDnsAwsProfile
type IPAMDNSAzureProfile ¶
type IPAMDNSAzureProfile struct { // Service principal based credentials for azure. Only one of azure_userpass or azure_serviceprincipal is allowed. Field introduced in 17.2.1. AzureServiceprincipal *AzureServicePrincipalCredentials `json:"azure_serviceprincipal,omitempty"` // User name password based credentials for azure. Only one of azure_userpass or azure_serviceprincipal is allowed. Field introduced in 17.2.1. AzureUserpass *AzureUserPassCredentials `json:"azure_userpass,omitempty"` // Used for allocating egress service source IPs. Field introduced in 17.2.8. Maximum of 1 items allowed. EgressServiceSubnets []string `json:"egress_service_subnets,omitempty"` // Azure resource group dedicated for Avi Controller. Avi Controller will create all its resources in this resource group. Field introduced in 17.2.1. ResourceGroup *string `json:"resource_group,omitempty"` // Subscription Id for the Azure subscription. Field introduced in 17.2.1. SubscriptionID *string `json:"subscription_id,omitempty"` // Usable domains to pick from Azure DNS. Field introduced in 17.2.1. UsableDomains []string `json:"usable_domains,omitempty"` // Usable networks for Virtual IP. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation. Field introduced in 17.2.1. Maximum of 128 items allowed. UsableNetworkUuids []string `json:"usable_network_uuids,omitempty"` // Use Azure's enhanced HA features. This needs a public IP to be associated with the VIP. Field introduced in 17.2.1. UseEnhancedHa *bool `json:"use_enhanced_ha,omitempty"` // Use Standard SKU Azure Load Balancer. By default Basic SKU Load Balancer is used. Field introduced in 17.2.7. UseStandardAlb *bool `json:"use_standard_alb,omitempty"` // Virtual networks where Virtual IPs will belong. Field introduced in 17.2.1. Maximum of 1 items allowed. VirtualNetworkIds []string `json:"virtual_network_ids,omitempty"` }
IPAMDNSAzureProfile ipam Dns azure profile swagger:model IpamDnsAzureProfile
type IPAMDNSCustomProfile ¶
type IPAMDNSCustomProfile struct { // It is a reference to an object of type CustomIpamDnsProfile. Field introduced in 17.1.1. CustomIPAMDNSProfileRef *string `json:"custom_ipam_dns_profile_ref,omitempty"` // Custom parameters that will passed to the IPAM/DNS provider including but not limited to provider credentials and API version. Field introduced in 17.1.1. DynamicParams []*CustomParams `json:"dynamic_params,omitempty"` // Usable domains. Field introduced in 17.2.2. UsableDomains []string `json:"usable_domains,omitempty"` // Usable subnets. Field introduced in 17.2.2. UsableSubnets []*IPAddrPrefix `json:"usable_subnets,omitempty"` }
IPAMDNSCustomProfile ipam Dns custom profile swagger:model IpamDnsCustomProfile
type IPAMDNSGCPProfile ¶
type IPAMDNSGCPProfile struct { // Match SE group subnets for VIP placement. Default is to not match SE group subnets. Field introduced in 17.1.1. MatchSeGroupSubnet *bool `json:"match_se_group_subnet,omitempty"` // Google Cloud Platform Network Host Project ID. This is the host project in which Google Cloud Platform Network resides. Field introduced in 18.1.2. NetworkHostProjectID *string `json:"network_host_project_id,omitempty"` // Google Cloud Platform Region Name. Field introduced in 18.1.2. RegionName *string `json:"region_name,omitempty"` // Google Cloud Platform Project ID. This is the project where service engines are hosted. This field is optional. By default it will use the value of the field network_host_project_id. Field introduced in 18.1.2. SeProjectID *string `json:"se_project_id,omitempty"` // Usable networks for Virtual IP. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation. It is a reference to an object of type Network. UsableNetworkRefs []string `json:"usable_network_refs,omitempty"` // Use Google Cloud Platform Network for Private VIP allocation. By default Avi Vantage Network is used for Private VIP allocation. Field introduced in 18.1.2. UseGcpNetwork *bool `json:"use_gcp_network,omitempty"` // Google Cloud Platform VPC Network Name. Field introduced in 18.1.2. VpcNetworkName *string `json:"vpc_network_name,omitempty"` }
IPAMDNSGCPProfile ipam Dns g c p profile swagger:model IpamDnsGCPProfile
type IPAMDNSInfobloxProfile ¶
type IPAMDNSInfobloxProfile struct { // DNS view. DNSView *string `json:"dns_view,omitempty"` // Custom parameters that will passed to the Infoblox provider as extensible attributes. Field introduced in 18.2.7, 20.1.1. ExtensibleAttributes []*CustomParams `json:"extensible_attributes,omitempty"` // Address of Infoblox appliance. // Required: true IPAddress *IPAddr `json:"ip_address"` // Network view. NetworkView *string `json:"network_view,omitempty"` // Password for API access for Infoblox appliance. // Required: true Password *string `json:"password"` // Subnets to use for Infoblox IP allocation. Field introduced in 18.2.8, 20.1.1. UsableAllocSubnets []*InfobloxSubnet `json:"usable_alloc_subnets,omitempty"` // Usable domains to pick from Infoblox. UsableDomains []string `json:"usable_domains,omitempty"` // This field is deprecated, use usable_alloc_subnets instead. Field deprecated in 18.2.8. UsableSubnets []*IPAddrPrefix `json:"usable_subnets,omitempty"` // Username for API access for Infoblox appliance. // Required: true Username *string `json:"username"` // WAPI version. WapiVersion *string `json:"wapi_version,omitempty"` }
IPAMDNSInfobloxProfile ipam Dns infoblox profile swagger:model IpamDnsInfobloxProfile
type IPAMDNSInternalProfile ¶
type IPAMDNSInternalProfile struct { // List of service domains. DNSServiceDomain []*DNSServiceDomain `json:"dns_service_domain,omitempty"` // Avi VirtualService to be used for serving DNS records. It is a reference to an object of type VirtualService. DNSVirtualserviceRef *string `json:"dns_virtualservice_ref,omitempty"` // Default TTL for all records, overridden by TTL value for each service domain configured in DnsServiceDomain. Allowed values are 1-604800. Unit is SEC. Allowed in Basic(Allowed values- 30) edition, Essentials(Allowed values- 30) edition, Enterprise edition. TTL *int32 `json:"ttl,omitempty"` // Use usable_networks. It is a reference to an object of type Network. Field deprecated in 20.1.3. UsableNetworkRefs []string `json:"usable_network_refs,omitempty"` // Usable networks for Virtual IP. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation. Field introduced in 20.1.3. Allowed in Basic edition, Essentials edition, Enterprise edition. UsableNetworks []*IPAMUsableNetwork `json:"usable_networks,omitempty"` }
IPAMDNSInternalProfile ipam Dns internal profile swagger:model IpamDnsInternalProfile
type IPAMDNSOCIprofile ¶
type IPAMDNSOCIprofile struct { // Credentials to access oracle cloud. It is a reference to an object of type CloudConnectorUser. Field introduced in 18.2.1,18.1.3. CloudCredentialsRef *string `json:"cloud_credentials_ref,omitempty"` // Region in which Oracle cloud resource resides. Field introduced in 18.2.1,18.1.3. Region *string `json:"region,omitempty"` // Oracle Cloud Id for tenant aka root compartment. Field introduced in 18.2.1,18.1.3. Tenancy *string `json:"tenancy,omitempty"` // Oracle cloud compartment id in which VCN resides. Field introduced in 18.2.1,18.1.3. VcnCompartmentID *string `json:"vcn_compartment_id,omitempty"` // Virtual Cloud network id where virtual ip will belong. Field introduced in 18.2.1,18.1.3. VcnID *string `json:"vcn_id,omitempty"` }
IPAMDNSOCIprofile ipam Dns o c iprofile swagger:model IpamDnsOCIProfile
type IPAMDNSOpenstackProfile ¶
type IPAMDNSOpenstackProfile struct { // Keystone's hostname or IP address. KeystoneHost *string `json:"keystone_host,omitempty"` // The password Avi Vantage will use when authenticating to Keystone. Password *string `json:"password,omitempty"` // Region name. Region *string `json:"region,omitempty"` // OpenStack tenant name. Tenant *string `json:"tenant,omitempty"` // The username Avi Vantage will use when authenticating to Keystone. Username *string `json:"username,omitempty"` // Network to be used for VIP allocation. VipNetworkName *string `json:"vip_network_name,omitempty"` }
IPAMDNSOpenstackProfile ipam Dns openstack profile swagger:model IpamDnsOpenstackProfile
type IPAMDNSProviderProfile ¶
type IPAMDNSProviderProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // If this flag is set, only allocate IP from networks in the Virtual Service VRF. Applicable for Avi Vantage IPAM only. Field introduced in 17.2.4. AllocateIPInVrf *bool `json:"allocate_ip_in_vrf,omitempty"` // Provider details if type is AWS. AwsProfile *IPAMDNSAwsProfile `json:"aws_profile,omitempty"` // Provider details if type is Microsoft Azure. Field introduced in 17.2.1. AzureProfile *IPAMDNSAzureProfile `json:"azure_profile,omitempty"` // Provider details if type is Custom. Field introduced in 17.1.1. CustomProfile *IPAMDNSCustomProfile `json:"custom_profile,omitempty"` // Provider details if type is Google Cloud. GcpProfile *IPAMDNSGCPProfile `json:"gcp_profile,omitempty"` // Provider details if type is Infoblox. InfobloxProfile *IPAMDNSInfobloxProfile `json:"infoblox_profile,omitempty"` // Provider details if type is Avi. InternalProfile *IPAMDNSInternalProfile `json:"internal_profile,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name for the IPAM/DNS Provider profile. // Required: true Name *string `json:"name"` // Provider details for Oracle Cloud. Field introduced in 18.2.1,18.1.3. OciProfile *IPAMDNSOCIprofile `json:"oci_profile,omitempty"` // Provider details if type is OpenStack. OpenstackProfile *IPAMDNSOpenstackProfile `json:"openstack_profile,omitempty"` // Field introduced in 17.1.1. ProxyConfiguration *ProxyConfiguration `json:"proxy_configuration,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Provider details for Tencent Cloud. Field introduced in 18.2.3. TencentProfile *IPAMDNSTencentProfile `json:"tencent_profile,omitempty"` // Provider Type for the IPAM/DNS Provider profile. Enum options - IPAMDNS_TYPE_INFOBLOX, IPAMDNS_TYPE_AWS, IPAMDNS_TYPE_OPENSTACK, IPAMDNS_TYPE_GCP, IPAMDNS_TYPE_INFOBLOX_DNS, IPAMDNS_TYPE_CUSTOM, IPAMDNS_TYPE_CUSTOM_DNS, IPAMDNS_TYPE_AZURE, IPAMDNS_TYPE_OCI, IPAMDNS_TYPE_TENCENT, IPAMDNS_TYPE_INTERNAL, IPAMDNS_TYPE_INTERNAL_DNS, IPAMDNS_TYPE_AWS_DNS, IPAMDNS_TYPE_AZURE_DNS. Allowed in Basic(Allowed values- IPAMDNS_TYPE_INTERNAL) edition, Essentials(Allowed values- IPAMDNS_TYPE_INTERNAL) edition, Enterprise edition. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the IPAM/DNS Provider profile. UUID *string `json:"uuid,omitempty"` }
IPAMDNSProviderProfile ipam Dns provider profile swagger:model IpamDnsProviderProfile
type IPAMDNSProviderProfileAPIResponse ¶
type IPAMDNSProviderProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*IPAMDNSProviderProfile `json:"results,omitempty"` }
IPAMDNSProviderProfileAPIResponse ipam Dns provider profile Api response swagger:model IpamDnsProviderProfileApiResponse
type IPAMDNSTencentProfile ¶
type IPAMDNSTencentProfile struct { // Credentials to access Tencent cloud. It is a reference to an object of type CloudConnectorUser. Field introduced in 18.2.3. CloudCredentialsRef *string `json:"cloud_credentials_ref,omitempty"` // VPC region. Field introduced in 18.2.3. // Required: true Region *string `json:"region"` // Usable networks for Virtual IP. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation. Field introduced in 18.2.3. UsableSubnetIds []string `json:"usable_subnet_ids,omitempty"` // VPC ID. Field introduced in 18.2.3. // Required: true VpcID *string `json:"vpc_id"` // Network configuration for Virtual IP per AZ. Field introduced in 18.2.3. Zones []*TencentZoneNetwork `json:"zones,omitempty"` }
IPAMDNSTencentProfile ipam Dns tencent profile swagger:model IpamDnsTencentProfile
type IPAMUsableNetwork ¶
type IPAMUsableNetwork struct { // Labels as key value pairs, used for selection of IPAM networks. Field introduced in 20.1.3. Maximum of 1 items allowed. Labels []*KeyValueTuple `json:"labels,omitempty"` // Network. It is a reference to an object of type Network. Field introduced in 20.1.3. // Required: true NwRef *string `json:"nw_ref"` }
IPAMUsableNetwork ipam usable network swagger:model IpamUsableNetwork
type IPAddr ¶
type IPAddr struct { // IP address. // Required: true Addr *string `json:"addr"` // Enum options - V4, DNS, V6. // Required: true Type *string `json:"type"` }
IPAddr Ip addr swagger:model IpAddr
type IPAddrGroup ¶
type IPAddrGroup struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Configure IP address(es). Addrs []*IPAddr `json:"addrs,omitempty"` // Populate IP addresses from members of this Cisco APIC EPG. ApicEpgName *string `json:"apic_epg_name,omitempty"` // Populate the IP address ranges from the geo database for this country. CountryCodes []string `json:"country_codes,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Configure (IP address, port) tuple(s). IPPorts []*IPAddrPort `json:"ip_ports,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Populate IP addresses from tasks of this Marathon app. MarathonAppName *string `json:"marathon_app_name,omitempty"` // Task port associated with marathon service port. If Marathon app has multiple service ports, this is required. Else, the first task port is used. MarathonServicePort *int32 `json:"marathon_service_port,omitempty"` // Name of the IP address group. // Required: true Name *string `json:"name"` // Configure IP address prefix(es). Prefixes []*IPAddrPrefix `json:"prefixes,omitempty"` // Configure IP address range(s). Ranges []*IPAddrRange `json:"ranges,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the IP address group. UUID *string `json:"uuid,omitempty"` }
IPAddrGroup Ip addr group swagger:model IpAddrGroup
type IPAddrGroupAPIResponse ¶
type IPAddrGroupAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*IPAddrGroup `json:"results,omitempty"` }
IPAddrGroupAPIResponse Ip addr group Api response swagger:model IpAddrGroupApiResponse
type IPAddrMatch ¶
type IPAddrMatch struct { // IP address(es). Addrs []*IPAddr `json:"addrs,omitempty"` // UUID of IP address group(s). It is a reference to an object of type IpAddrGroup. GroupRefs []string `json:"group_refs,omitempty"` // Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. // Required: true MatchCriteria *string `json:"match_criteria"` // IP address prefix(es). Prefixes []*IPAddrPrefix `json:"prefixes,omitempty"` // IP address range(s). Ranges []*IPAddrRange `json:"ranges,omitempty"` }
IPAddrMatch Ip addr match swagger:model IpAddrMatch
type IPAddrPort ¶
type IPAddrPort struct { // Hostname of server. One of IP address or hostname should be set. Hostname *string `json:"hostname,omitempty"` // IP Address of host. One of IP address or hostname should be set. IP *IPAddr `json:"ip,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Port number of server. Allowed values are 1-65535. // Required: true Port *int32 `json:"port"` }
IPAddrPort Ip addr port swagger:model IpAddrPort
type IPAddrPrefix ¶
type IPAddrPrefix struct { // Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object // Required: true IPAddr *IPAddr `json:"ip_addr"` // Number of mask. // Required: true Mask *int32 `json:"mask"` }
IPAddrPrefix Ip addr prefix swagger:model IpAddrPrefix
type IPAddrRange ¶
type IPAddrRange struct { // Starting IP address of the range. // Required: true Begin *IPAddr `json:"begin"` // Ending IP address of the range. // Required: true End *IPAddr `json:"end"` }
IPAddrRange Ip addr range swagger:model IpAddrRange
type IPAllocInfo ¶
type IPAllocInfo struct { // Placeholder for description of property ip of obj type IpAllocInfo field type str type object // Required: true IP *IPAddr `json:"ip"` // mac of IpAllocInfo. // Required: true Mac *string `json:"mac"` // Unique object identifier of se. // Required: true SeUUID *string `json:"se_uuid"` }
IPAllocInfo Ip alloc info swagger:model IpAllocInfo
type IPCommunity ¶
type IPCommunity struct { // Community *string either in aa nn format where aa, nn is within [1,65535] or local-AS|no-advertise|no-export|internet. Field introduced in 17.1.3. Minimum of 1 items required. Maximum of 16 items allowed. Community []string `json:"community,omitempty"` // Beginning of IP address range. Field introduced in 17.1.3. // Required: true IPBegin *IPAddr `json:"ip_begin"` // End of IP address range. Optional if ip_begin is the only IP address in specified IP range. Field introduced in 17.1.3. IPEnd *IPAddr `json:"ip_end,omitempty"` }
IPCommunity Ip community swagger:model IpCommunity
type IPNetworkSubnet ¶
type IPNetworkSubnet struct { // Network for VirtualService IP allocation with Vantage as the IPAM provider. Network should be created before this is configured. It is a reference to an object of type Network. NetworkRef *string `json:"network_ref,omitempty"` // Subnet for VirtualService IP allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Subnet *IPAddrPrefix `json:"subnet,omitempty"` // Subnet for VirtualService IPv6 allocation with Vantage or Infoblox as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. Subnet6 *IPAddrPrefix `json:"subnet6,omitempty"` // Subnet UUID or Name or Prefix for VirtualService IPv6 allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. Subnet6UUID *string `json:"subnet6_uuid,omitempty"` // Subnet UUID or Name or Prefix for VirtualService IP allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. SubnetUUID *string `json:"subnet_uuid,omitempty"` }
IPNetworkSubnet IP network subnet swagger:model IPNetworkSubnet
type IPPersistenceProfile ¶
type IPPersistenceProfile struct { // Mask to be applied on client IP. This may be used to persist clients from a subnet to the same server. When set to 0, all requests are sent to the same server. Allowed values are 0-128. Field introduced in 18.2.7. Allowed in Basic edition, Essentials edition, Enterprise edition. IPMask *int32 `json:"ip_mask,omitempty"` // The length of time after a client's connections have closed before expiring the client's persistence to a server. Allowed values are 1-720. Unit is MIN. IPPersistentTimeout *int32 `json:"ip_persistent_timeout,omitempty"` }
IPPersistenceProfile IP persistence profile swagger:model IPPersistenceProfile
type IPReputationConfig ¶
type IPReputationConfig struct { // IP reputation db file object expiry duration in days. Allowed values are 1-7. Field introduced in 20.1.1. Unit is DAYS. IPReputationFileObjectExpiryDuration *int32 `json:"ip_reputation_file_object_expiry_duration,omitempty"` // IP reputation db sync interval in minutes. Allowed values are 2-1440. Field introduced in 20.1.1. Unit is MIN. Allowed in Basic(Allowed values- 60) edition, Essentials(Allowed values- 60) edition, Enterprise edition. IPReputationSyncInterval *int32 `json:"ip_reputation_sync_interval,omitempty"` }
IPReputationConfig Ip reputation config swagger:model IpReputationConfig
type IPReputationDB ¶
type IPReputationDB struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // IP reputation DB base file. It is a reference to an object of type FileObject. Field introduced in 20.1.1. Maximum of 1 items allowed. BaseFileRefs []string `json:"base_file_refs,omitempty"` // Description. Field introduced in 20.1.1. Description *string `json:"description,omitempty"` // IP reputation DB incremental update files. It is a reference to an object of type FileObject. Field introduced in 20.1.1. IncrementalFileRefs []string `json:"incremental_file_refs,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // IP reputation DB name. Field introduced in 20.1.1. // Required: true Name *string `json:"name"` // If this object is managed by the IP reputation service, this field contain the status of this syncronization. Field introduced in 20.1.1. ServiceStatus *IPReputationServiceStatus `json:"service_status,omitempty"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 20.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of this object. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` // Organization providing IP reputation data. Enum options - IP_REPUTATION_VENDOR_WEBROOT. Field introduced in 20.1.1. // Required: true Vendor *string `json:"vendor"` // A version number for this database object. This is informal for the consumer of this API only, a tool which manages this object can store version information here. Field introduced in 20.1.1. Version *string `json:"version,omitempty"` }
IPReputationDB IP reputation d b swagger:model IPReputationDB
type IPReputationDBAPIResponse ¶
type IPReputationDBAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*IPReputationDB `json:"results,omitempty"` }
IPReputationDBAPIResponse IP reputation d b Api response swagger:model IPReputationDBApiResponse
type IPReputationServiceStatus ¶
type IPReputationServiceStatus struct { // If the last attempted update failed, this is a more detailed error message. Field introduced in 20.1.1. Error *string `json:"error,omitempty"` // The time when the IP reputation service last successfull attemped to update this object. This is the case when either this file references in this object got updated or when the IP reputation service knows positively that there are no newer versions for these files. It will be not update, if an error occurs during an update attempt. In this case, the errror will be set. Field introduced in 20.1.1. LastSuccessfulUpdateCheck *TimeStamp `json:"last_successful_update_check,omitempty"` }
IPReputationServiceStatus IP reputation service status swagger:model IPReputationServiceStatus
type IPReputationTypeMapping ¶
type IPReputationTypeMapping struct { // The Bot Identification to which the IP reputation type is mapped. Field introduced in 21.1.1. // Required: true BotIdentification *BotIdentification `json:"bot_identification"` // The type of IP reputation that is mapped to a Bot Identification. Enum options - IP_REPUTATION_TYPE_SPAM_SOURCE, IP_REPUTATION_TYPE_WINDOWS_EXPLOITS, IP_REPUTATION_TYPE_WEB_ATTACKS, IP_REPUTATION_TYPE_BOTNETS, IP_REPUTATION_TYPE_SCANNERS, IP_REPUTATION_TYPE_DOS, IP_REPUTATION_TYPE_REPUTATION, IP_REPUTATION_TYPE_PHISHING, IP_REPUTATION_TYPE_PROXY, IP_REPUTATION_TYPE_CLOUD, IP_REPUTATION_TYPE_MOBILE_THREATS, IP_REPUTATION_TYPE_TOR, IP_REPUTATION_TYPE_ALL. Field introduced in 21.1.1. // Required: true IPReputationType *string `json:"ip_reputation_type"` }
IPReputationTypeMapping IP reputation type mapping swagger:model IPReputationTypeMapping
type IPReputationTypeMatch ¶
type IPReputationTypeMatch struct { // Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 20.1.1. // Required: true MatchOperation *string `json:"match_operation"` // IP reputation type. Enum options - IP_REPUTATION_TYPE_SPAM_SOURCE, IP_REPUTATION_TYPE_WINDOWS_EXPLOITS, IP_REPUTATION_TYPE_WEB_ATTACKS, IP_REPUTATION_TYPE_BOTNETS, IP_REPUTATION_TYPE_SCANNERS, IP_REPUTATION_TYPE_DOS, IP_REPUTATION_TYPE_REPUTATION, IP_REPUTATION_TYPE_PHISHING, IP_REPUTATION_TYPE_PROXY, IP_REPUTATION_TYPE_CLOUD, IP_REPUTATION_TYPE_MOBILE_THREATS, IP_REPUTATION_TYPE_TOR, IP_REPUTATION_TYPE_ALL. Field introduced in 20.1.1. Minimum of 1 items required. ReputationTypes []string `json:"reputation_types,omitempty"` }
IPReputationTypeMatch IP reputation type match swagger:model IPReputationTypeMatch
type IPThreatDBEventData ¶
type IPThreatDBEventData struct { // Reason for IPThreatDb transaction failure. Field introduced in 20.1.1. Reason *string `json:"reason,omitempty"` // Status of IPThreatDb transaction. Field introduced in 20.1.1. Status *string `json:"status,omitempty"` // Last synced version of the IPThreatDB. Field introduced in 20.1.1. Version *string `json:"version,omitempty"` }
IPThreatDBEventData IP threat d b event data swagger:model IPThreatDBEventData
type IcapLog ¶
type IcapLog struct { // Denotes whether the content was processed by ICAP server and an action was taken. Enum options - ICAP_DISABLED, ICAP_PASSED, ICAP_MODIFIED, ICAP_BLOCKED, ICAP_FAILED. Field introduced in 20.1.1. Action *string `json:"action,omitempty"` // Logs for the HTTP request's content sent to the ICAP server. Field introduced in 20.1.1. RequestLogs []*IcapRequestLog `json:"request_logs,omitempty"` }
IcapLog icap log swagger:model IcapLog
type IcapProfile ¶
type IcapProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Allow ICAP server to send 204 response as described in RFC 3507 section 4.5. Service Engine will buffer the complete request if alllow_204 is enabled. If disabled, preview_size request body will be buffered if enable_preview is set to true, and rest of the request body will be streamed to the ICAP server. Field introduced in 20.1.3. Allow204 *bool `json:"allow_204,omitempty"` // The maximum buffer size for the HTTP request body. If the request body exceeds this size, the request will not be checked by the ICAP server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is KB. BufferSize *int32 `json:"buffer_size,omitempty"` // Decide what should happen if the request body size exceeds the configured buffer size. If this is set to Fail Open, the request will not be checked by the ICAP server. If this is set to Fail Closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. BufferSizeExceedAction *string `json:"buffer_size_exceed_action,omitempty"` // The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type Cloud. Field introduced in 20.1.1. CloudRef *string `json:"cloud_ref,omitempty"` // A description for this ICAP profile. Field introduced in 20.1.1. Description *string `json:"description,omitempty"` // Use the ICAP preview feature as described in RFC 3507 section 4.5. Field introduced in 20.1.1. EnablePreview *bool `json:"enable_preview,omitempty"` // Decide what should happen if there is a problem with the ICAP server like communication timeout, protocol error, pool error, etc. If this is set to Fail Open, the request will continue, but will create a significant log entry. If this is set to Fail Closed, the request will be rejected with a 500 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1. FailAction *string `json:"fail_action,omitempty"` // Name of the ICAP profile. Field introduced in 20.1.1. // Required: true Name *string `json:"name"` // The pool group which is used to connect to ICAP servers. It is a reference to an object of type PoolGroup. Field introduced in 20.1.1. // Required: true PoolGroupRef *string `json:"pool_group_ref"` // The ICAP preview size as described in RFC 3507 section 4.5. This should not exceed the size supported by the ICAP server. If this is set to 0, only the HTTP header will be sent to the ICAP server as a preview. To disable preview completely, set the enable-preview option to false. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is BYTES. PreviewSize *int32 `json:"preview_size,omitempty"` // Maximum time, client's request will be paused for ICAP processing. If this timeout is exceeded, the request to the ICAP server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is MILLISECONDS. ResponseTimeout *int32 `json:"response_timeout,omitempty"` // The path and query component of the ICAP URL. Host name and port will be taken from the pool. Field introduced in 20.1.1. // Required: true ServiceURI *string `json:"service_uri"` // If the ICAP request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is MILLISECONDS. SlowResponseWarningThreshold *int32 `json:"slow_response_warning_threshold,omitempty"` // Tenant which this object belongs to. It is a reference to an object of type Tenant. Field introduced in 20.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the ICAP profile. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` // The vendor of the ICAP server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT. Field introduced in 20.1.1. Vendor *string `json:"vendor,omitempty"` }
IcapProfile icap profile swagger:model IcapProfile
type IcapProfileAPIResponse ¶
type IcapProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*IcapProfile `json:"results,omitempty"` }
IcapProfileAPIResponse icap profile Api response swagger:model IcapProfileApiResponse
type IcapRequestLog ¶
type IcapRequestLog struct { // Denotes whether the content was processed by ICAP server and an action was taken. Enum options - ICAP_DISABLED, ICAP_PASSED, ICAP_MODIFIED, ICAP_BLOCKED, ICAP_FAILED. Field introduced in 20.1.1. Action *string `json:"action,omitempty"` // Complete request body from client was sent to The ICAP server. Field introduced in 20.1.1. CompleteBodySent *bool `json:"complete_body_sent,omitempty"` // The HTTP method of the request. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 20.1.1. HTTPMethod *string `json:"http_method,omitempty"` // The HTTP response code received from the ICAP server. HTTP response code is only available if content is blocked. Field introduced in 20.1.1. HTTPResponseCode *int32 `json:"http_response_code,omitempty"` // The absolute ICAP uri of the request. Field introduced in 20.1.1. IcapAbsoluteURI *string `json:"icap_absolute_uri,omitempty"` // ICAP response headers received from ICAP server. Field introduced in 20.1.1. IcapHeadersReceivedFromServer *string `json:"icap_headers_received_from_server,omitempty"` // ICAP request headers sent to ICAP server. Field introduced in 20.1.1. IcapHeadersSentToServer *string `json:"icap_headers_sent_to_server,omitempty"` // The ICAP method of the request. Enum options - ICAP_METHOD_REQMOD, ICAP_METHOD_RESPMOD. Field introduced in 20.1.1. IcapMethod *string `json:"icap_method,omitempty"` // The response code received from the ICAP server. Field introduced in 20.1.1. IcapResponseCode *int32 `json:"icap_response_code,omitempty"` // ICAP server IP for this connection. Field introduced in 20.1.3. IcapServerIP *int32 `json:"icap_server_ip,omitempty"` // ICAP server port for this connection. Field introduced in 20.1.3. IcapServerPort *int32 `json:"icap_server_port,omitempty"` // Latency added due to ICAP processing. This is the time taken from 1st byte of ICAP request sent to last byte of ICAP response received. Field introduced in 20.1.1. Unit is MILLISECONDS. Latency *int64 `json:"latency,omitempty"` // Content-Length of the modified content from ICAP server. Field introduced in 20.1.1. ModifiedContentLength *int32 `json:"modified_content_length,omitempty"` // The name of the pool that was used for the request. Field introduced in 20.1.1. PoolName *string `json:"pool_name,omitempty"` // The uuid of the pool that was used for the request. Field introduced in 20.1.1. PoolUUID *string `json:"pool_uuid,omitempty"` // Blocking reason for the content. It is available only if content was scanned by ICAP server and some violations were found. Field introduced in 20.1.1. Reason *string `json:"reason,omitempty"` // ICAP server IP for this connection. Field deprecated in 20.1.3. Field introduced in 20.1.1. ServerIP *IPAddr `json:"server_ip,omitempty"` // Source port for this connection. Field introduced in 20.1.1. SourcePort *int32 `json:"source_port,omitempty"` // Detailed description of the threat found in the content. Available only if request was scanned by ICAP server and some violations were found. Field deprecated in 20.1.3. Field introduced in 20.1.1. ThreatDescription *string `json:"threat_description,omitempty"` // Short description of the threat found in the content. Available only if content was scanned by ICAP server and some violations were found. Field introduced in 20.1.1. ThreatID *string `json:"threat_id,omitempty"` // Threat found in the content. Available only if content was scanned by ICAP server and some violations were found. Field introduced in 20.1.3. Violations []*IcapViolation `json:"violations,omitempty"` }
IcapRequestLog icap request log swagger:model IcapRequestLog
type IcapViolation ¶
type IcapViolation struct { // The file that ICAP server has identified as containing a violation. Field introduced in 20.1.3. FileName *string `json:"file_name,omitempty"` // Action taken by ICAP server in response to this threat. Enum options - ICAP_FILE_NOT_REPAIRED, ICAP_FILE_REPAIRED, ICAP_VIOLATING_SECTION_REMOVED. Field introduced in 20.1.3. Resolution *string `json:"resolution,omitempty"` // The name of the threat. Field introduced in 20.1.3. ThreatName *string `json:"threat_name,omitempty"` }
IcapViolation icap violation swagger:model IcapViolation
type Image ¶
type Image struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // This field describes the cloud info specific to the base image. Field introduced in 20.1.1. CloudInfoValues []*ImageCloudData `json:"cloud_info_values,omitempty"` // Controller package details. Field introduced in 18.2.6. ControllerInfo *PackageDetails `json:"controller_info,omitempty"` // Mandatory Controller patch name that is applied along with this base image. Field introduced in 18.2.10, 20.1.1. ControllerPatchName *string `json:"controller_patch_name,omitempty"` // It references the controller-patch associated with the Uber image. Field introduced in 18.2.8, 20.1.1. ControllerPatchUUID *string `json:"controller_patch_uuid,omitempty"` // This field describes the api migration related information. Field introduced in 18.2.6. Migrations *SupportedMigrations `json:"migrations,omitempty"` // Name of the image. Field introduced in 18.2.6. // Required: true Name *string `json:"name"` // SE package details. Field introduced in 18.2.6. SeInfo *PackageDetails `json:"se_info,omitempty"` // Mandatory ServiceEngine patch name that is applied along with this base image. Field introduced in 18.2.10, 20.1.1. SePatchName *string `json:"se_patch_name,omitempty"` // It references the Service Engine patch associated with the Uber Image. Field introduced in 18.2.8, 20.1.1. SePatchUUID *string `json:"se_patch_uuid,omitempty"` // Status to check if the image is present. Enum options - SYSERR_SUCCESS, SYSERR_FAILURE, SYSERR_OUT_OF_MEMORY, SYSERR_NO_ENT, SYSERR_INVAL, SYSERR_ACCESS, SYSERR_FAULT, SYSERR_IO, SYSERR_TIMEOUT, SYSERR_NOT_SUPPORTED, SYSERR_NOT_READY, SYSERR_UPGRADE_IN_PROGRESS, SYSERR_WARM_START_IN_PROGRESS, SYSERR_TRY_AGAIN, SYSERR_NOT_UPGRADING, SYSERR_PENDING, SYSERR_EVENT_GEN_FAILURE, SYSERR_CONFIG_PARAM_MISSING, SYSERR_RANGE, SYSERR_BAD_REQUEST.... Field introduced in 18.2.6. Status *string `json:"status,omitempty"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.6. TenantRef *string `json:"tenant_ref,omitempty"` // Type of the image patch/system. Enum options - IMAGE_TYPE_PATCH, IMAGE_TYPE_SYSTEM, IMAGE_TYPE_MUST_CHECK. Field introduced in 18.2.6. Type *string `json:"type,omitempty"` // Status to check if the image is an uber bundle. Field introduced in 18.2.8, 20.1.1. UberBundle *bool `json:"uber_bundle,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the image. Field introduced in 18.2.6. UUID *string `json:"uuid,omitempty"` }
Image image swagger:model Image
type ImageAPIResponse ¶
type ImageAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Image `json:"results,omitempty"` }
ImageAPIResponse image Api response swagger:model ImageApiResponse
type ImageCloudData ¶
type ImageCloudData struct { // Cloud Data specific to a particular cloud. Field introduced in 20.1.1. CloudDataValues []*ImageCloudSpecificData `json:"cloud_data_values,omitempty"` // Contains the name of the cloud. Field introduced in 20.1.1. CloudName *string `json:"cloud_name,omitempty"` }
ImageCloudData image cloud data swagger:model ImageCloudData
type ImageCloudSpecificData ¶
type ImageCloudSpecificData struct { // Each cloud has specific parameters. Field introduced in 20.1.1. Key *string `json:"key,omitempty"` // Each parameter can have multiple values. Field introduced in 20.1.1. Values []string `json:"values,omitempty"` }
ImageCloudSpecificData image cloud specific data swagger:model ImageCloudSpecificData
type InfobloxSubnet ¶
type InfobloxSubnet struct { // IPv4 subnet to use for Infoblox allocation. Field introduced in 18.2.8, 20.1.1. Subnet *IPAddrPrefix `json:"subnet,omitempty"` // IPv6 subnet to use for Infoblox allocation. Field introduced in 18.2.8, 20.1.1. Subnet6 *IPAddrPrefix `json:"subnet6,omitempty"` }
InfobloxSubnet infoblox subnet swagger:model InfobloxSubnet
type IngAttribute ¶
type IngAttribute struct { // Attribute to match. Field introduced in 17.2.15, 18.1.5, 18.2.1. Attribute *string `json:"attribute,omitempty"` // Attribute value. If not set, match any value. Field introduced in 17.2.15, 18.1.5, 18.2.1. Value *string `json:"value,omitempty"` }
IngAttribute ing attribute swagger:model IngAttribute
type InternalGatewayMonitor ¶
type InternalGatewayMonitor struct { // Disable the gateway monitor for default gateway. They are monitored by default. Field introduced in 17.1.1. DisableGatewayMonitor *bool `json:"disable_gateway_monitor,omitempty"` // The number of consecutive failed gateway health checks before a gateway is marked down. Allowed values are 3-50. Field introduced in 17.1.1. GatewayMonitorFailureThreshold *int32 `json:"gateway_monitor_failure_threshold,omitempty"` // The interval between two ping requests sent by the gateway monitor in milliseconds. If a value is not specified, requests are sent every second. Allowed values are 100-60000. Field introduced in 17.1.1. Unit is MILLISECONDS. GatewayMonitorInterval *int32 `json:"gateway_monitor_interval,omitempty"` // The number of consecutive successful gateway health checks before a gateway that was marked down by the gateway monitor is marked up. Allowed values are 3-50. Field introduced in 17.1.1. GatewayMonitorSuccessThreshold *int32 `json:"gateway_monitor_success_threshold,omitempty"` }
InternalGatewayMonitor internal gateway monitor swagger:model InternalGatewayMonitor
type IptableRule ¶
type IptableRule struct { // Enum options - ACCEPT, DROP, REJECT, DNAT, MASQUERADE. // Required: true Action *string `json:"action"` // Placeholder for description of property dnat_ip of obj type IptableRule field type str type object DnatIP *IPAddr `json:"dnat_ip,omitempty"` // Placeholder for description of property dst_ip of obj type IptableRule field type str type object DstIP *IPAddrPrefix `json:"dst_ip,omitempty"` // Placeholder for description of property dst_port of obj type IptableRule field type str type object DstPort *PortRange `json:"dst_port,omitempty"` // input_interface of IptableRule. InputInterface *string `json:"input_interface,omitempty"` // output_interface of IptableRule. OutputInterface *string `json:"output_interface,omitempty"` // Enum options - PROTO_TCP, PROTO_UDP, PROTO_ICMP, PROTO_ALL. Proto *string `json:"proto,omitempty"` // Placeholder for description of property src_ip of obj type IptableRule field type str type object SrcIP *IPAddrPrefix `json:"src_ip,omitempty"` // Placeholder for description of property src_port of obj type IptableRule field type str type object SrcPort *PortRange `json:"src_port,omitempty"` // tag of IptableRule. Tag *string `json:"tag,omitempty"` }
IptableRule iptable rule swagger:model IptableRule
type IptableRuleSet ¶
type IptableRuleSet struct { // chain of IptableRuleSet. // Required: true Chain *string `json:"chain"` // Placeholder for description of property rules of obj type IptableRuleSet field type str type object Rules []*IptableRule `json:"rules,omitempty"` // table of IptableRuleSet. // Required: true Table *string `json:"table"` }
IptableRuleSet iptable rule set swagger:model IptableRuleSet
type JWTClaimMatch ¶
type JWTClaimMatch struct { // Boolean value against which the claim is matched. Field introduced in 20.1.3. BoolMatch *bool `json:"bool_match,omitempty"` // Integer value against which the claim is matched. Field introduced in 20.1.3. IntMatch *int32 `json:"int_match,omitempty"` // Specified Claim should be present in the JWT. Field introduced in 20.1.3. // Required: true IsMandatory *bool `json:"is_mandatory"` // JWT Claim name to be validated. Field introduced in 20.1.3. // Required: true Name *string `json:"name"` // String values against which the claim is matched. Field introduced in 20.1.3. StringMatch *StringMatch `json:"string_match,omitempty"` // Specifies the type of the Claim. Enum options - JWT_CLAIM_TYPE_BOOL, JWT_CLAIM_TYPE_INT, JWT_CLAIM_TYPE_STRING. Field introduced in 20.1.3. // Required: true Type *string `json:"type"` // Specifies whether to validate the Claim value. Field introduced in 20.1.3. // Required: true Validate *bool `json:"validate"` }
JWTClaimMatch j w t claim match swagger:model JWTClaimMatch
type JWTMatch ¶
type JWTMatch struct { // Claims whose values need to be matched. Field introduced in 20.1.3. Matches []*JWTClaimMatch `json:"matches,omitempty"` // Token for which the claims need to be validated. Field introduced in 20.1.3. TokenName *string `json:"token_name,omitempty"` }
JWTMatch j w t match swagger:model JWTMatch
type JWTServerProfile ¶
type JWTServerProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Uniquely identifiable name of the Token Issuer. Field introduced in 20.1.3. // Required: true Issuer *string `json:"issuer"` // JWKS key set used for validating the JWT. Field introduced in 20.1.3. // Required: true JwksKeys *string `json:"jwks_keys"` // Name of the JWT Profile. Field introduced in 20.1.3. // Required: true Name *string `json:"name"` // UUID of the Tenant. It is a reference to an object of type Tenant. Field introduced in 20.1.3. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the JWTProfile. Field introduced in 20.1.3. UUID *string `json:"uuid,omitempty"` }
JWTServerProfile j w t server profile swagger:model JWTServerProfile
type JWTServerProfileAPIResponse ¶
type JWTServerProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*JWTServerProfile `json:"results,omitempty"` }
JWTServerProfileAPIResponse j w t server profile Api response swagger:model JWTServerProfileApiResponse
type JWTValidationVsConfig ¶
type JWTValidationVsConfig struct { // Uniquely identifies a resource server. This is used to validate against the aud claim. Field introduced in 20.1.3. // Required: true Audience *string `json:"audience"` // Defines where to look for JWT in the request. Enum options - JWT_LOCATION_AUTHORIZATION_HEADER, JWT_LOCATION_QUERY_PARAM. Field introduced in 20.1.3. // Required: true JwtLocation *string `json:"jwt_location"` // Name by which the JWT can be identified if the token is sent as a query param in the request url. Field introduced in 20.1.3. JwtName *string `json:"jwt_name,omitempty"` }
JWTValidationVsConfig j w t validation vs config swagger:model JWTValidationVsConfig
type JobEntry ¶
type JobEntry struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // expires_at of JobEntry. // Required: true ExpiresAt *string `json:"expires_at"` // Field introduced in 18.1.2. // Required: true Name *string `json:"name"` // obj_key of JobEntry. // Required: true ObjKey *string `json:"obj_key"` // Field introduced in 18.1.1. Subjobs []*SubJob `json:"subjobs,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
JobEntry job entry swagger:model JobEntry
type JobEntryAPIResponse ¶
type JobEntryAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*JobEntry `json:"results,omitempty"` }
JobEntryAPIResponse job entry Api response swagger:model JobEntryApiResponse
type JwtLog ¶
type JwtLog struct { // Authentication policy rule match. Field introduced in 20.1.3. AuthnRuleMatch *AuthnRuleMatch `json:"authn_rule_match,omitempty"` // Authorization policy rule match. Field introduced in 20.1.3. AuthzRuleMatch *AuthzRuleMatch `json:"authz_rule_match,omitempty"` // Set to true, if JWT validation is successful. Field introduced in 20.1.3. IsJwtVerified *bool `json:"is_jwt_verified,omitempty"` // JWT token payload. Field introduced in 20.1.3. TokenPayload *string `json:"token_payload,omitempty"` }
JwtLog jwt log swagger:model JwtLog
type KeyValue ¶
type KeyValue struct { // Key. // Required: true Key *string `json:"key"` // Value. Value *string `json:"value,omitempty"` }
KeyValue key value swagger:model KeyValue
type KeyValueTuple ¶
type KeyValueTuple struct { // Key. Field introduced in 20.1.3. // Required: true Key *string `json:"key"` // Value. Field introduced in 20.1.3. Value *string `json:"value,omitempty"` }
KeyValueTuple key value tuple swagger:model KeyValueTuple
type L4ConnectionPolicy ¶
type L4ConnectionPolicy struct { // Rules to apply when a new transport connection is setup. Field introduced in 17.2.7. Rules []*L4Rule `json:"rules,omitempty"` }
L4ConnectionPolicy l4 connection policy swagger:model L4ConnectionPolicy
type L4Policies ¶
type L4Policies struct { // Index of the virtual service L4 policy set. Field introduced in 17.2.7. // Required: true Index *int32 `json:"index"` // ID of the virtual service L4 policy set. It is a reference to an object of type L4PolicySet. Field introduced in 17.2.7. // Required: true L4PolicySetRef *string `json:"l4_policy_set_ref"` }
L4Policies l4 policies swagger:model L4Policies
type L4PolicySet ¶
type L4PolicySet struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Creator name. Field introduced in 17.2.7. CreatedBy *string `json:"created_by,omitempty"` // Field introduced in 17.2.7. Description *string `json:"description,omitempty"` // Field introduced in 17.2.7. IsInternalPolicy *bool `json:"is_internal_policy,omitempty"` // Policy to apply when a new transport connection is setup. Field introduced in 17.2.7. L4ConnectionPolicy *L4ConnectionPolicy `json:"l4_connection_policy,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the L4 Policy Set. Field introduced in 17.2.7. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 17.2.7. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // ID of the L4 Policy Set. Field introduced in 17.2.7. UUID *string `json:"uuid,omitempty"` }
L4PolicySet l4 policy set swagger:model L4PolicySet
type L4PolicySetAPIResponse ¶
type L4PolicySetAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*L4PolicySet `json:"results,omitempty"` }
L4PolicySetAPIResponse l4 policy set Api response swagger:model L4PolicySetApiResponse
type L4Rule ¶
type L4Rule struct { // Action to be performed upon successful rule match. Field introduced in 17.2.7. Action *L4RuleAction `json:"action,omitempty"` // Enable or disable the rule. Field introduced in 17.2.7. Enable *bool `json:"enable,omitempty"` // Index of the rule. Field introduced in 17.2.7. // Required: true Index *int32 `json:"index"` // Match criteria of the rule. Field introduced in 17.2.7. Match *L4RuleMatchTarget `json:"match,omitempty"` // Name of the rule. Field introduced in 17.2.7. // Required: true Name *string `json:"name"` }
L4Rule l4 rule swagger:model L4Rule
type L4RuleAction ¶
type L4RuleAction struct { // Indicates pool or pool-group selection on rule match. Field introduced in 17.2.7. SelectPool *L4RuleActionSelectPool `json:"select_pool,omitempty"` }
L4RuleAction l4 rule action swagger:model L4RuleAction
type L4RuleActionSelectPool ¶
type L4RuleActionSelectPool struct { // Indicates action to take on rule match. Enum options - L4_RULE_ACTION_SELECT_POOL, L4_RULE_ACTION_SELECT_POOLGROUP. Field introduced in 17.2.7. Allowed in Basic(Allowed values- L4_RULE_ACTION_SELECT_POOL) edition, Essentials(Allowed values- L4_RULE_ACTION_SELECT_POOL) edition, Enterprise edition. // Required: true ActionType *string `json:"action_type"` // ID of the pool group to serve the request. It is a reference to an object of type PoolGroup. Field introduced in 17.2.7. Allowed in Basic edition, Essentials edition, Enterprise edition. PoolGroupRef *string `json:"pool_group_ref,omitempty"` // ID of the pool of servers to serve the request. It is a reference to an object of type Pool. Field introduced in 17.2.7. PoolRef *string `json:"pool_ref,omitempty"` }
L4RuleActionSelectPool l4 rule action select pool swagger:model L4RuleActionSelectPool
type L4RuleMatchTarget ¶
type L4RuleMatchTarget struct { // IP addresses to match against client IP. Field introduced in 17.2.7. Allowed in Basic edition, Essentials edition, Enterprise edition. ClientIP *IPAddrMatch `json:"client_ip,omitempty"` // Port number to match against Virtual Service listner port. Field introduced in 17.2.7. Port *L4RulePortMatch `json:"port,omitempty"` // TCP/UDP/ICMP protocol to match against transport protocol. Field introduced in 17.2.7. Allowed in Basic edition, Essentials edition, Enterprise edition. Protocol *L4RuleProtocolMatch `json:"protocol,omitempty"` }
L4RuleMatchTarget l4 rule match target swagger:model L4RuleMatchTarget
type L4RulePortMatch ¶
type L4RulePortMatch struct { // Criterion to use for Virtual Service port matching. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.2.7. // Required: true MatchCriteria *string `json:"match_criteria"` // Range of TCP/UDP port numbers of the Virtual Service. Field introduced in 17.2.7. PortRanges []*PortRange `json:"port_ranges,omitempty"` // Virtual Service's listening port(s). Allowed values are 1-65535. Field introduced in 17.2.7. Ports []int64 `json:"ports,omitempty,omitempty"` }
L4RulePortMatch l4 rule port match swagger:model L4RulePortMatch
type L4RuleProtocolMatch ¶
type L4RuleProtocolMatch struct { // Criterion to use for transport protocol matching. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.2.7. // Required: true MatchCriteria *string `json:"match_criteria"` // Transport protocol to match. Enum options - PROTOCOL_ICMP, PROTOCOL_TCP, PROTOCOL_UDP. Field introduced in 17.2.7. // Required: true Protocol *string `json:"protocol"` }
L4RuleProtocolMatch l4 rule protocol match swagger:model L4RuleProtocolMatch
type LdapAuthSettings ¶
type LdapAuthSettings struct { // The LDAP base DN. For example, avinetworks.com would be DC=avinetworks,DC=com. BaseDn *string `json:"base_dn,omitempty"` // LDAP administrator credentials are used to search for users and group memberships. BindAsAdministrator *bool `json:"bind_as_administrator,omitempty"` // LDAP attribute that refers to user email. EmailAttribute *string `json:"email_attribute,omitempty"` // LDAP attribute that refers to user's full name. FullNameAttribute *string `json:"full_name_attribute,omitempty"` // Query the LDAP servers on this port. Port *int32 `json:"port,omitempty"` // LDAP connection security mode. Enum options - AUTH_LDAP_SECURE_NONE, AUTH_LDAP_SECURE_USE_LDAPS. SecurityMode *string `json:"security_mode,omitempty"` // LDAP server IP address or Hostname. Use IP address if an auth profile is used to configure Virtual Service. Minimum of 1 items required. Server []string `json:"server,omitempty"` // LDAP full directory configuration with administrator credentials. Settings *LdapDirectorySettings `json:"settings,omitempty"` // LDAP anonymous bind configuration. UserBind *LdapUserBindSettings `json:"user_bind,omitempty"` }
LdapAuthSettings ldap auth settings swagger:model LdapAuthSettings
type LdapDirectorySettings ¶
type LdapDirectorySettings struct { // LDAP Admin User DN. Administrator credentials are required to search for users under user search DN or groups under group search DN. AdminBindDn *string `json:"admin_bind_dn,omitempty"` // Group filter is used to identify groups during search. GroupFilter *string `json:"group_filter,omitempty"` // LDAP group attribute that identifies each of the group members. GroupMemberAttribute *string `json:"group_member_attribute,omitempty"` // Group member entries contain full DNs instead of just user id attribute values. GroupMemberIsFullDn *bool `json:"group_member_is_full_dn,omitempty"` // LDAP group search DN is the root of search for a given group in the LDAP directory. Only matching groups present in this LDAP directory sub-tree will be checked for user membership. GroupSearchDn *string `json:"group_search_dn,omitempty"` // LDAP group search scope defines how deep to search for the group starting from the group search DN. Enum options - AUTH_LDAP_SCOPE_BASE, AUTH_LDAP_SCOPE_ONE, AUTH_LDAP_SCOPE_SUBTREE. GroupSearchScope *string `json:"group_search_scope,omitempty"` // During user or group search, ignore searching referrals. IgnoreReferrals *bool `json:"ignore_referrals,omitempty"` // LDAP Admin User Password. Password *string `json:"password,omitempty"` // LDAP user attributes to fetch on a successful user bind. UserAttributes []string `json:"user_attributes,omitempty"` // LDAP user id attribute is the login attribute that uniquely identifies a single user record. UserIDAttribute *string `json:"user_id_attribute,omitempty"` // LDAP user search DN is the root of search for a given user in the LDAP directory. Only user records present in this LDAP directory sub-tree will be validated. UserSearchDn *string `json:"user_search_dn,omitempty"` // LDAP user search scope defines how deep to search for the user starting from user search DN. Enum options - AUTH_LDAP_SCOPE_BASE, AUTH_LDAP_SCOPE_ONE, AUTH_LDAP_SCOPE_SUBTREE. UserSearchScope *string `json:"user_search_scope,omitempty"` }
LdapDirectorySettings ldap directory settings swagger:model LdapDirectorySettings
type LdapUserBindSettings ¶
type LdapUserBindSettings struct { // LDAP user DN pattern is used to bind LDAP user after replacing the user token with real username. DnTemplate *string `json:"dn_template,omitempty"` // LDAP token is replaced with real user name in the user DN pattern. Token *string `json:"token,omitempty"` // LDAP user attributes to fetch on a successful user bind. UserAttributes []string `json:"user_attributes,omitempty"` // LDAP user id attribute is the login attribute that uniquely identifies a single user record. UserIDAttribute *string `json:"user_id_attribute,omitempty"` }
LdapUserBindSettings ldap user bind settings swagger:model LdapUserBindSettings
type LearningLogPolicy ¶
type LearningLogPolicy struct { // Determine whether app learning logging is enabled. Field introduced in 20.1.3. Enabled *bool `json:"enabled,omitempty"` // Host name where learning logs will be sent to. Field introduced in 20.1.3. Host *string `json:"host,omitempty"` // Port number for the service listening for learning logs. Field introduced in 20.1.3. Port *int32 `json:"port,omitempty"` }
LearningLogPolicy learning log policy swagger:model LearningLogPolicy
type LicenseDetails ¶
type LicenseDetails struct { // Number of backend_servers. BackendServers *int32 `json:"backend_servers,omitempty"` // expiry_at of LicenseDetails. ExpiryAt *string `json:"expiry_at,omitempty"` // license_id of LicenseDetails. LicenseID *string `json:"license_id,omitempty"` // license_type of LicenseDetails. LicenseType *string `json:"license_type,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` }
LicenseDetails license details swagger:model LicenseDetails
type LicenseExpiryDetails ¶
type LicenseExpiryDetails struct { // Number of backend_servers. BackendServers *int32 `json:"backend_servers,omitempty"` // Number of burst_cores. BurstCores *int32 `json:"burst_cores,omitempty"` // Number of cores. Cores *int32 `json:"cores,omitempty"` // Placeholder for description of property cpu_cores of obj type LicenseExpiryDetails field type str type number CPUCores *float64 `json:"cpu_cores,omitempty"` // expiry_at of LicenseExpiryDetails. ExpiryAt *string `json:"expiry_at,omitempty"` // license_id of LicenseExpiryDetails. LicenseID *string `json:"license_id,omitempty"` // license_tier of LicenseExpiryDetails. LicenseTier []string `json:"license_tier,omitempty"` // license_type of LicenseExpiryDetails. LicenseType *string `json:"license_type,omitempty"` // Number of max_apps. MaxApps *int32 `json:"max_apps,omitempty"` // Number of max_ses. MaxSes *int32 `json:"max_ses,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Placeholder for description of property service_cores of obj type LicenseExpiryDetails field type str type number ServiceCores *float64 `json:"service_cores,omitempty"` // Number of sockets. Sockets *int32 `json:"sockets,omitempty"` // Number of throughput. Throughput *int32 `json:"throughput,omitempty"` }
LicenseExpiryDetails license expiry details swagger:model LicenseExpiryDetails
type LicenseInfo ¶
type LicenseInfo struct { // Last updated time. Field introduced in 20.1.1. // Required: true LastUpdated *int64 `json:"last_updated"` // Quantity of service cores. Field introduced in 20.1.1. // Required: true ServiceCores *float64 `json:"service_cores"` // Specifies the license tier. Field introduced in 20.1.1. TenantUUID *string `json:"tenant_uuid,omitempty"` // Specifies the license tier. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS. Field introduced in 20.1.1. // Required: true Tier *string `json:"tier"` // Identifier(license_id, se_uuid, cookie). Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` }
LicenseInfo license info swagger:model LicenseInfo
type LicenseLedgerDetails ¶
type LicenseLedgerDetails struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Maintain information about reservation against cookie. Field introduced in 20.1.1. EscrowInfos []*LicenseInfo `json:"escrow_infos,omitempty"` // Maintain information about consumed licenses against se_uuid. Field introduced in 20.1.1. SeInfos []*LicenseInfo `json:"se_infos,omitempty"` // License usage per tier. Field introduced in 20.1.1. TierUsages []*LicenseTierUsage `json:"tier_usages,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Uuid for reference. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` }
LicenseLedgerDetails license ledger details swagger:model LicenseLedgerDetails
type LicenseLedgerDetailsAPIResponse ¶
type LicenseLedgerDetailsAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*LicenseLedgerDetails `json:"results,omitempty"` }
LicenseLedgerDetailsAPIResponse license ledger details Api response swagger:model LicenseLedgerDetailsApiResponse
type LicenseTierSwitchDetiails ¶
type LicenseTierSwitchDetiails struct { // destination_tier of LicenseTierSwitchDetiails. DestinationTier *string `json:"destination_tier,omitempty"` // reason of LicenseTierSwitchDetiails. Reason *string `json:"reason,omitempty"` // source_tier of LicenseTierSwitchDetiails. SourceTier *string `json:"source_tier,omitempty"` // status of LicenseTierSwitchDetiails. Status *string `json:"status,omitempty"` }
LicenseTierSwitchDetiails license tier switch detiails swagger:model LicenseTierSwitchDetiails
type LicenseTierUsage ¶
type LicenseTierUsage struct { // Specifies the license tier. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS. Field introduced in 20.1.1. Tier *string `json:"tier,omitempty"` // Usage stats of license tier. Field introduced in 20.1.1. Usage *LicenseUsage `json:"usage,omitempty"` }
LicenseTierUsage license tier usage swagger:model LicenseTierUsage
type LicenseTransactionDetails ¶
type LicenseTransactionDetails struct { // cookie of LicenseTransactionDetails. Cookie *string `json:"cookie,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // id of LicenseTransactionDetails. ID *string `json:"id,omitempty"` // Placeholder for description of property licensed_service_cores of obj type LicenseTransactionDetails field type str type number LicensedServiceCores *float64 `json:"licensed_service_cores,omitempty"` // operation of LicenseTransactionDetails. Operation *string `json:"operation,omitempty"` // Placeholder for description of property overdraft of obj type LicenseTransactionDetails field type str type boolean Overdraft *bool `json:"overdraft,omitempty"` // Placeholder for description of property service_cores of obj type LicenseTransactionDetails field type str type number ServiceCores *float64 `json:"service_cores,omitempty"` // Unique object identifier of tenant. TenantUUID *string `json:"tenant_uuid,omitempty"` // tier of LicenseTransactionDetails. Tier *string `json:"tier,omitempty"` }
LicenseTransactionDetails license transaction details swagger:model LicenseTransactionDetails
type LicenseUsage ¶
type LicenseUsage struct { // Total license cores available for consumption. Field introduced in 20.1.1. Available *float64 `json:"available,omitempty"` // Total license cores consumed. Field introduced in 20.1.1. Consumed *float64 `json:"consumed,omitempty"` // Total license cores reserved or escrowed. Field introduced in 20.1.1. Escrow *float64 `json:"escrow,omitempty"` // Total license cores remaining for consumption. Field introduced in 20.1.1. Remaining *float64 `json:"remaining,omitempty"` }
LicenseUsage license usage swagger:model LicenseUsage
type Lif ¶
type Lif struct { // Placeholder for description of property cifs of obj type Lif field type str type object Cifs []*Cif `json:"cifs,omitempty"` // lif of Lif. Lif *string `json:"lif,omitempty"` // lif_label of Lif. LifLabel *string `json:"lif_label,omitempty"` // subnet of Lif. Subnet *string `json:"subnet,omitempty"` }
Lif lif swagger:model Lif
type LinuxConfiguration ¶
type LinuxConfiguration struct { // Banner displayed before login to ssh, and UI. Banner *string `json:"banner,omitempty"` // Enforce CIS benchmark recommendations for Avi Controller and Service Engines. The enforcement is as per CIS DIL 1.0.1 level 2, for applicable controls. Field introduced in 17.2.8. CisMode *bool `json:"cis_mode,omitempty"` // Message of the day, shown to users on login via the command line interface, web interface, or ssh. Motd *string `json:"motd,omitempty"` }
LinuxConfiguration linux configuration swagger:model LinuxConfiguration
type LinuxServerConfiguration ¶
type LinuxServerConfiguration struct { // Private docker registry for SE image storage. Field deprecated in 17.1.2. DockerRegistrySe *DockerRegistry `json:"docker_registry_se,omitempty"` // Placeholder for description of property hosts of obj type LinuxServerConfiguration field type str type object Hosts []*LinuxServerHost `json:"hosts,omitempty"` // Flag to notify the SE's in this cloud have an inband management interface, this can be overridden at SE host level by setting host_attr attr_key as SE_INBAND_MGMT with value of true or false. SeInbandMgmt *bool `json:"se_inband_mgmt,omitempty"` // SE Client Logs disk path for cloud. SeLogDiskPath *string `json:"se_log_disk_path,omitempty"` // SE Client Log disk size for cloud. SeLogDiskSizeGB *int32 `json:"se_log_disk_size_GB,omitempty"` // SE System Logs disk path for cloud. SeSysDiskPath *string `json:"se_sys_disk_path,omitempty"` // SE System Logs disk size for cloud. SeSysDiskSizeGB *int32 `json:"se_sys_disk_size_GB,omitempty"` // Parameters for SSH to hosts. Field deprecated in 17.1.1. SSHAttr *SSHSeDeployment `json:"ssh_attr,omitempty"` // Cloud connector user uuid for SSH to hosts. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.1.1. SSHUserRef *string `json:"ssh_user_ref,omitempty"` }
LinuxServerConfiguration linux server configuration swagger:model LinuxServerConfiguration
type LinuxServerHost ¶
type LinuxServerHost struct { // Placeholder for description of property host_attr of obj type LinuxServerHost field type str type object HostAttr []*HostAttributes `json:"host_attr,omitempty"` // Placeholder for description of property host_ip of obj type LinuxServerHost field type str type object // Required: true HostIP *IPAddr `json:"host_ip"` // Node's availability zone. ServiceEngines belonging to the availability zone will be rebooted during a manual DR failover. NodeAvailabilityZone *string `json:"node_availability_zone,omitempty"` // The SE Group association for the SE. If None, then 'Default-Group' SEGroup is associated with the SE. It is a reference to an object of type ServiceEngineGroup. Field introduced in 17.2.1. SeGroupRef *string `json:"se_group_ref,omitempty"` }
LinuxServerHost linux server host swagger:model LinuxServerHost
type LocationHdrMatch ¶
type LocationHdrMatch struct { // Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. MatchCase *string `json:"match_case,omitempty"` // Criterion to use for matching location header value in the HTTP response. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL. // Required: true MatchCriteria *string `json:"match_criteria"` // String value(s) in the location header. Value []string `json:"value,omitempty"` }
LocationHdrMatch location hdr match swagger:model LocationHdrMatch
type LogAgentEventDetail ¶
type LogAgentEventDetail struct { // Protocol used for communication to the external entity. Enum options - TCP_CONN. Field introduced in 20.1.3. // Required: true Protocol *string `json:"protocol"` // Event details for TCP connection event. Field introduced in 20.1.3. TCPDetail *LogAgentTCPClientEventDetail `json:"tcp_detail,omitempty"` // Type of log agent event. Enum options - LOG_AGENT_CONNECTION_ERROR. Field introduced in 20.1.3. // Required: true Type *string `json:"type"` }
LogAgentEventDetail log agent event detail swagger:model LogAgentEventDetail
type LogAgentTCPClientEventDetail ¶
type LogAgentTCPClientEventDetail struct { // Field introduced in 20.1.3. ErrorCode *string `json:"error_code,omitempty"` // Field introduced in 20.1.3. ErrorReason *string `json:"error_reason,omitempty"` // Field introduced in 20.1.3. Host *string `json:"host,omitempty"` // Field introduced in 20.1.3. Port *string `json:"port,omitempty"` }
LogAgentTCPClientEventDetail log agent TCP client event detail swagger:model LogAgentTCPClientEventDetail
type LogControllerMapping ¶
type LogControllerMapping struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // controller_ip of LogControllerMapping. ControllerIP *string `json:"controller_ip,omitempty"` // Enum options - METRICS_MGR_PORT_0, METRICS_MGR_PORT_1, METRICS_MGR_PORT_2, METRICS_MGR_PORT_3. MetricsMgrPort *string `json:"metrics_mgr_port,omitempty"` // Unique object identifier of node. NodeUUID *string `json:"node_uuid,omitempty"` // prev_controller_ip of LogControllerMapping. PrevControllerIP *string `json:"prev_controller_ip,omitempty"` // Enum options - METRICS_MGR_PORT_0, METRICS_MGR_PORT_1, METRICS_MGR_PORT_2, METRICS_MGR_PORT_3. PrevMetricsMgrPort *string `json:"prev_metrics_mgr_port,omitempty"` // Placeholder for description of property static_mapping of obj type LogControllerMapping field type str type boolean StaticMapping *bool `json:"static_mapping,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
LogControllerMapping log controller mapping swagger:model LogControllerMapping
type LogControllerMappingAPIResponse ¶
type LogControllerMappingAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*LogControllerMapping `json:"results,omitempty"` }
LogControllerMappingAPIResponse log controller mapping Api response swagger:model LogControllerMappingApiResponse
type MarathonConfiguration ¶
type MarathonConfiguration struct { // Framework tag to be used in Virtualservice name. Default is framework name from Mesos. If this tag is altered atruntime, Virtualservices will be deleted and re-created. FrameworkTag *string `json:"framework_tag,omitempty"` // Password for Marathon authentication. MarathonPassword *string `json:"marathon_password,omitempty"` // Marathon API URL of the form http //host port. MarathonURL *string `json:"marathon_url,omitempty"` // Username for Marathon authentication. MarathonUsername *string `json:"marathon_username,omitempty"` // Private port range allocated to this Marathon framework instance. PrivatePortRange *PortRange `json:"private_port_range,omitempty"` // Public port range allocated to this Marathon framework instance. PublicPortRange *PortRange `json:"public_port_range,omitempty"` // Tenant to pin this Marathon instance to. If set, a tenant object will be created in Avi bearing this name and all applications created in this marathon will be associated with this tenant regardless of, if any, tenant configuration in marathon label for this application. Tenant *string `json:"tenant,omitempty"` // Use Token based authentication instead of basic authentication. Token is refreshed every 5 minutes. UseTokenAuth *bool `json:"use_token_auth,omitempty"` // Tag VS name with framework name or framework_tag. Useful in deployments with multiple frameworks. VsNameTagFramework *bool `json:"vs_name_tag_framework,omitempty"` }
MarathonConfiguration marathon configuration swagger:model MarathonConfiguration
type MarathonSeDeployment ¶
type MarathonSeDeployment struct { // Docker image to be used for Avi SE installation e.g. fedora, ubuntu. DockerImage *string `json:"docker_image,omitempty"` // Host OS distribution e.g. COREOS, UBUNTU, REDHAT. HostOs *string `json:"host_os,omitempty"` // Accepted resource roles for SEs. ResourceRoles []string `json:"resource_roles,omitempty"` // URIs to be resolved for starting the application. Uris []string `json:"uris,omitempty"` }
MarathonSeDeployment marathon se deployment swagger:model MarathonSeDeployment
type MarathonServicePortConflict ¶
type MarathonServicePortConflict struct { // app_name of MarathonServicePortConflict. AppName *string `json:"app_name,omitempty"` // cc_id of MarathonServicePortConflict. CcID *string `json:"cc_id,omitempty"` // marathon_url of MarathonServicePortConflict. // Required: true MarathonURL *string `json:"marathon_url"` // Number of port. // Required: true Port *int32 `json:"port"` }
MarathonServicePortConflict marathon service port conflict swagger:model MarathonServicePortConflict
type MatchReplacePair ¶
type MatchReplacePair struct { // String to be matched. // Required: true MatchString *string `json:"match_string"` // Replacement string. ReplacementString *ReplaceStringVar `json:"replacement_string,omitempty"` }
MatchReplacePair match replace pair swagger:model MatchReplacePair
type MatchTarget ¶
type MatchTarget struct { // Configure the bot classification result. Field introduced in 21.1.1. BotDetectionResult *BotDetectionMatch `json:"bot_detection_result,omitempty"` // Configure client ip addresses. ClientIP *IPAddrMatch `json:"client_ip,omitempty"` // Configure HTTP cookie(s). Cookie *CookieMatch `json:"cookie,omitempty"` // Configure the geo information. Field introduced in 21.1.1. Maximum of 1 items allowed. GeoMatches []*GeoMatch `json:"geo_matches,omitempty"` // Configure HTTP header(s). Hdrs []*HdrMatch `json:"hdrs,omitempty"` // Configure the host header. HostHdr *HostHdrMatch `json:"host_hdr,omitempty"` // Configure IP reputation. Field introduced in 20.1.3. IPReputationType *IPReputationTypeMatch `json:"ip_reputation_type,omitempty"` // Configure HTTP methods. Method *MethodMatch `json:"method,omitempty"` // Configure request paths. Path *PathMatch `json:"path,omitempty"` // Configure the type of HTTP protocol. Protocol *ProtocolMatch `json:"protocol,omitempty"` // Configure request query. Query *QueryMatch `json:"query,omitempty"` // Configure versions of the HTTP protocol. Version *HTTPVersionMatch `json:"version,omitempty"` // Configure virtual service ports. VsPort *PortMatch `json:"vs_port,omitempty"` }
MatchTarget match target swagger:model MatchTarget
type MemberInterface ¶
type MemberInterface struct { // Placeholder for description of property active of obj type MemberInterface field type str type boolean Active *bool `json:"active,omitempty"` // if_name of MemberInterface. // Required: true IfName *string `json:"if_name"` // Field introduced in 17.1.5. MacAddress *string `json:"mac_address,omitempty"` }
MemberInterface member interface swagger:model MemberInterface
type MemoryBalancerInfo ¶
type MemoryBalancerInfo struct { // Child Process information. Child []*ChildProcessInfo `json:"child,omitempty"` // Controller memory. ControllerMemory *int32 `json:"controller_memory,omitempty"` // Limit on the memory (in MB) for the Process. Limit *int32 `json:"limit,omitempty"` // Amount of memory (in MB) used by the Process. MemoryUsed *int32 `json:"memory_used,omitempty"` // PID of the Process. Pid *int32 `json:"pid,omitempty"` // Name of the Process. Process *string `json:"process,omitempty"` }
MemoryBalancerInfo memory balancer info swagger:model MemoryBalancerInfo
type MesosAttribute ¶
type MesosAttribute struct { // Attribute to match. // Required: true Attribute *string `json:"attribute"` // Attribute value. If not set, match any value. Value *string `json:"value,omitempty"` }
MesosAttribute mesos attribute swagger:model MesosAttribute
type MesosConfiguration ¶
type MesosConfiguration struct { // Consider all Virtualservices as Front End Proxies. Front End proxies are placed on specific SEs as opposed to Back End proxies placed on all SEs. Applicable where each service has its own VIP and VIP is reachable from anywhere. AllVsesAreFeproxy *bool `json:"all_vses_are_feproxy,omitempty"` // Sync frequency in seconds with frameworks. AppSyncFrequency *int32 `json:"app_sync_frequency,omitempty"` // Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService. ContainerPortMatchHTTPService *bool `json:"container_port_match_http_service,omitempty"` // Directory to mount to check for core dumps on Service Engines. This will be mapped read only to /var/crash on any new Service Engines. This is a disruptive change. CoredumpDirectory *string `json:"coredump_directory,omitempty"` // Disable auto service sync for back end services. DisableAutoBackendServiceSync *bool `json:"disable_auto_backend_service_sync,omitempty"` // Disable auto service sync for front end services. DisableAutoFrontendServiceSync *bool `json:"disable_auto_frontend_service_sync,omitempty"` // Disable auto sync for GSLB services. Field introduced in 17.1.2. DisableAutoGsSync *bool `json:"disable_auto_gs_sync,omitempty"` // Disable SE creation. DisableAutoSeCreation *bool `json:"disable_auto_se_creation,omitempty"` // Docker registry for ServiceEngine image. DockerRegistrySe *DockerRegistry `json:"docker_registry_se,omitempty"` // Match against this prefix when placing east-west VSs on SEs (Mesos mode only). EastWestPlacementSubnet *IPAddrPrefix `json:"east_west_placement_subnet,omitempty"` // Enable Marathon event subscriptions. EnableEventSubscription *bool `json:"enable_event_subscription,omitempty"` // Name of second Linux bridge on Host providing connectivity for Front End proxies. This is a disruptive change. FeproxyBridgeName *string `json:"feproxy_bridge_name,omitempty"` // For Front End proxies, use container port as service port. FeproxyContainerPortAsService *bool `json:"feproxy_container_port_as_service,omitempty"` // Publish ECMP route to upstream router for VIP. FeproxyRoutePublish *FeProxyRoutePublishConfig `json:"feproxy_route_publish,omitempty"` // Enable proxy ARP from Host interface for Front End proxies. FeproxyVipsEnableProxyArp *bool `json:"feproxy_vips_enable_proxy_arp,omitempty"` // Optional fleet remote endpoint if fleet is used for SE deployment. FleetEndpoint *string `json:"fleet_endpoint,omitempty"` // List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80. HTTPContainerPorts []int64 `json:"http_container_ports,omitempty,omitempty"` // List of Marathon frameworks. MarathonConfigurations []*MarathonConfiguration `json:"marathon_configurations,omitempty"` // Options for Marathon SE deployment. MarathonSeDeployment *MarathonSeDeployment `json:"marathon_se_deployment,omitempty"` // Mesos URL of the form http //host port. MesosURL *string `json:"mesos_url,omitempty"` // Mesos Node label to be used as Mesos Node's availability zone in a dual availability zone deployment. ServiceEngines belonging to the availability zone will be rebooted during a manual DR failover. NodeAvailabilityZoneLabel *string `json:"node_availability_zone_label,omitempty"` // Nuage Overlay SDN Controller information. NuageController *NuageSDNController `json:"nuage_controller,omitempty"` // Use Fleet/SSH for deploying Service Engines. Enum options - MESOS_SE_CREATE_FLEET, MESOS_SE_CREATE_SSH, MESOS_SE_CREATE_MARATHON. SeDeploymentMethod *string `json:"se_deployment_method,omitempty"` // Exclude hosts with attributes for SE creation. SeExcludeAttributes []*MesosAttribute `json:"se_exclude_attributes,omitempty"` // Create SEs just on hosts with include attributes. SeIncludeAttributes []*MesosAttribute `json:"se_include_attributes,omitempty"` // Obsolete - ignored. SeResources []*MesosSeResources `json:"se_resources,omitempty"` // New SE spawn rate per minute. SeSpawnRate *int32 `json:"se_spawn_rate,omitempty"` // Host volume to be used as a disk for Avi SE, This is a disruptive change. SeVolume *string `json:"se_volume,omitempty"` // Make service ports accessible on all Host interfaces in addition to East-West VIP and/or bridge IP. Usually enabled AWS Mesos clusters to export East-West services on Host interface. ServicesAccessibleAllInterfaces *bool `json:"services_accessible_all_interfaces,omitempty"` // Parameters for SSH SE deployment. Field deprecated in 17.1.1. SSHSeDeployment *SSHSeDeployment `json:"ssh_se_deployment,omitempty"` // Cloud connector user uuid for SSH to hosts. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.1.1. SSHUserRef *string `json:"ssh_user_ref,omitempty"` // Use Bridge IP on each Host as VIP. UseBridgeIPAsVip *bool `json:"use_bridge_ip_as_vip,omitempty"` // Use container IP address port for pool instead of host IP address hostport. This mode is applicable if the container IP is reachable (not a private NATed IP) from other hosts in a routed environment for containers. UseContainerIPPort *bool `json:"use_container_ip_port,omitempty"` // If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se. UseControllerImage *bool `json:"use_controller_image,omitempty"` // Use unique virtual IP address for every east west service in Mesos/Marathon. 'use_bridge_ip_as_vip' and 'vip' fields , if set, will not be used if this field is set. UseVipsForEastWestServices *bool `json:"use_vips_for_east_west_services,omitempty"` // VIP to be used by all East-West apps on all Hosts. Preferrably use an address from outside the subnet. Vip *IPAddr `json:"vip,omitempty"` }
MesosConfiguration mesos configuration swagger:model MesosConfiguration
type MesosMetricsDebugFilter ¶
type MesosMetricsDebugFilter struct { // mesos_master of MesosMetricsDebugFilter. MesosMaster *string `json:"mesos_master,omitempty"` // mesos_slave of MesosMetricsDebugFilter. MesosSLAVE *string `json:"mesos_slave,omitempty"` // Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. MetricEntity *string `json:"metric_entity,omitempty"` // Number of metrics_collection_frq. MetricsCollectionFrq *int32 `json:"metrics_collection_frq,omitempty"` }
MesosMetricsDebugFilter mesos metrics debug filter swagger:model MesosMetricsDebugFilter
type MesosSeResources ¶
type MesosSeResources struct { // Attribute (Fleet or Mesos) key of Hosts. // Required: true AttributeKey *string `json:"attribute_key"` // Attribute (Fleet or Mesos) value of Hosts. // Required: true AttributeValue *string `json:"attribute_value"` // Obsolete - ignored. CPU *float32 `json:"cpu,omitempty"` // Obsolete - ignored. Memory *int32 `json:"memory,omitempty"` }
MesosSeResources mesos se resources swagger:model MesosSeResources
type MesosSetup ¶
type MesosSetup struct { // cc_id of MesosSetup. CcID *string `json:"cc_id,omitempty"` // failed_hosts of MesosSetup. FailedHosts []string `json:"failed_hosts,omitempty"` // fleet_endpoint of MesosSetup. FleetEndpoint *string `json:"fleet_endpoint,omitempty"` // hosts of MesosSetup. Hosts []string `json:"hosts,omitempty"` // Placeholder for description of property mesos_access of obj type MesosSetup field type str type boolean MesosAccess *bool `json:"mesos_access,omitempty"` // mesos_url of MesosSetup. MesosURL *string `json:"mesos_url,omitempty"` // missing_hosts of MesosSetup. MissingHosts []string `json:"missing_hosts,omitempty"` // new_hosts of MesosSetup. NewHosts []string `json:"new_hosts,omitempty"` // reason of MesosSetup. Reason *string `json:"reason,omitempty"` // Placeholder for description of property se_deploy_method_access of obj type MesosSetup field type str type boolean SeDeployMethodAccess *bool `json:"se_deploy_method_access,omitempty"` // se_name of MesosSetup. SeName *string `json:"se_name,omitempty"` // version of MesosSetup. Version *string `json:"version,omitempty"` }
MesosSetup mesos setup swagger:model MesosSetup
type MethodMatch ¶
type MethodMatch struct { // Criterion to use for HTTP method matching the method in the HTTP request. Enum options - IS_IN, IS_NOT_IN. // Required: true MatchCriteria *string `json:"match_criteria"` // Configure HTTP method(s). Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Minimum of 1 items required. Maximum of 16 items allowed. Allowed in Basic(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS) edition, Essentials(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS) edition, Enterprise edition. Methods []string `json:"methods,omitempty"` }
MethodMatch method match swagger:model MethodMatch
type MetricLog ¶
type MetricLog struct { // Placeholder for description of property end_timestamp of obj type MetricLog field type str type number EndTimestamp *float64 `json:"end_timestamp,omitempty"` // metric_id of MetricLog. // Required: true MetricID *string `json:"metric_id"` // Placeholder for description of property report_timestamp of obj type MetricLog field type str type number ReportTimestamp *float64 `json:"report_timestamp,omitempty"` // Number of step. Step *int32 `json:"step,omitempty"` // Placeholder for description of property time_series of obj type MetricLog field type str type object TimeSeries *MetricsQueryResponse `json:"time_series,omitempty"` // Placeholder for description of property value of obj type MetricLog field type str type number // Required: true Value *float64 `json:"value"` }
MetricLog metric log swagger:model MetricLog
type MetricStatistics ¶
type MetricStatistics struct { // value of the last sample. LastSample *float64 `json:"last_sample,omitempty"` // maximum value in time series requested. Max *float64 `json:"max,omitempty"` // timestamp of the minimum value. MaxTs *string `json:"max_ts,omitempty"` // arithmetic mean. Mean *float64 `json:"mean,omitempty"` // minimum value in time series requested. Min *float64 `json:"min,omitempty"` // timestamp of the minimum value. MinTs *string `json:"min_ts,omitempty"` // Number of actual data samples. It excludes fake data. NumSamples *int32 `json:"num_samples,omitempty"` // summation of all values. Sum *float64 `json:"sum,omitempty"` // slope of the data points across the time series requested. trend = (last_value - avg)/avg. Trend *float64 `json:"trend,omitempty"` }
MetricStatistics metric statistics swagger:model MetricStatistics
type MetricThresoldUpDetails ¶
type MetricThresoldUpDetails struct { // Placeholder for description of property current_value of obj type MetricThresoldUpDetails field type str type number CurrentValue *float64 `json:"current_value,omitempty"` // ID of the object whose metric has hit the threshold. EntityUUID *string `json:"entity_uuid,omitempty"` // metric_id of MetricThresoldUpDetails. MetricID *string `json:"metric_id,omitempty"` // metric_name of MetricThresoldUpDetails. // Required: true MetricName *string `json:"metric_name"` // Identity of the Pool. PoolUUID *string `json:"pool_uuid,omitempty"` // Server IP Port on which event was generated. Server *string `json:"server,omitempty"` // Placeholder for description of property threshold of obj type MetricThresoldUpDetails field type str type number Threshold *float64 `json:"threshold,omitempty"` }
MetricThresoldUpDetails metric thresold up details swagger:model MetricThresoldUpDetails
type MetricsAPISrvDebugFilter ¶
type MetricsAPISrvDebugFilter struct { // uuid of the entity. It is a reference to an object of type Virtualservice. Field introduced in 18.2.3. EntityRef *string `json:"entity_ref,omitempty"` }
MetricsAPISrvDebugFilter metrics Api srv debug filter swagger:model MetricsApiSrvDebugFilter
type MetricsData ¶
type MetricsData struct { // Placeholder for description of property application_response_time of obj type MetricsData field type str type number ApplicationResponseTime *float64 `json:"application_response_time,omitempty"` // Placeholder for description of property blocking_time of obj type MetricsData field type str type number BlockingTime *float64 `json:"blocking_time,omitempty"` // Placeholder for description of property browser_rendering_time of obj type MetricsData field type str type number BrowserRenderingTime *float64 `json:"browser_rendering_time,omitempty"` // Placeholder for description of property client_rtt of obj type MetricsData field type str type number ClientRtt *float64 `json:"client_rtt,omitempty"` // Placeholder for description of property connection_time of obj type MetricsData field type str type number ConnectionTime *float64 `json:"connection_time,omitempty"` // Placeholder for description of property dns_lookup_time of obj type MetricsData field type str type number DNSLookupTime *float64 `json:"dns_lookup_time,omitempty"` // Placeholder for description of property dom_content_load_time of obj type MetricsData field type str type number DomContentLoadTime *float64 `json:"dom_content_load_time,omitempty"` // Placeholder for description of property is_null of obj type MetricsData field type str type boolean IsNull *bool `json:"is_null,omitempty"` // Number of num_samples. NumSamples *int32 `json:"num_samples,omitempty"` // Placeholder for description of property page_download_time of obj type MetricsData field type str type number PageDownloadTime *float64 `json:"page_download_time,omitempty"` // Placeholder for description of property page_load_time of obj type MetricsData field type str type number PageLoadTime *float64 `json:"page_load_time,omitempty"` // Placeholder for description of property prediction_interval_high of obj type MetricsData field type str type number PredictionIntervalHigh *float64 `json:"prediction_interval_high,omitempty"` // Placeholder for description of property prediction_interval_low of obj type MetricsData field type str type number PredictionIntervalLow *float64 `json:"prediction_interval_low,omitempty"` // Placeholder for description of property redirection_time of obj type MetricsData field type str type number RedirectionTime *float64 `json:"redirection_time,omitempty"` // Placeholder for description of property rum_client_data_transfer_time of obj type MetricsData field type str type number RumClientDataTransferTime *float64 `json:"rum_client_data_transfer_time,omitempty"` // Placeholder for description of property server_rtt of obj type MetricsData field type str type number ServerRtt *float64 `json:"server_rtt,omitempty"` // Placeholder for description of property service_time of obj type MetricsData field type str type number ServiceTime *float64 `json:"service_time,omitempty"` // timestamp of MetricsData. Timestamp *string `json:"timestamp,omitempty"` // Placeholder for description of property value of obj type MetricsData field type str type number // Required: true Value *float64 `json:"value"` // Field introduced in 17.2.2. ValueStr *string `json:"value_str,omitempty"` // Field introduced in 17.2.2. ValueStrDesc *string `json:"value_str_desc,omitempty"` // Placeholder for description of property waiting_time of obj type MetricsData field type str type number WaitingTime *float64 `json:"waiting_time,omitempty"` }
MetricsData metrics data swagger:model MetricsData
type MetricsDataHeader ¶
type MetricsDataHeader struct { // Metrics derivation info. DerivationData *MetricsDerivationData `json:"derivation_data,omitempty"` // Placeholder for description of property dimension_data of obj type MetricsDataHeader field type str type object DimensionData []*MetricsDimensionData `json:"dimension_data,omitempty"` // entity uuid. EntityUUID *string `json:"entity_uuid,omitempty"` // metric_description of MetricsDataHeader. MetricDescription *string `json:"metric_description,omitempty"` // Placeholder for description of property metrics_min_scale of obj type MetricsDataHeader field type str type number MetricsMinScale *float64 `json:"metrics_min_scale,omitempty"` // Placeholder for description of property metrics_sum_agg_invalid of obj type MetricsDataHeader field type str type boolean MetricsSumAggInvalid *bool `json:"metrics_sum_agg_invalid,omitempty"` // Missing data intervals. data in these intervals are not used for stats calculation. MissingIntervals []*MetricsMissingDataInterval `json:"missing_intervals,omitempty"` // name of the column. // Required: true Name *string `json:"name"` // object ID of the series when object ID was specified in the metric. ObjID *string `json:"obj_id,omitempty"` // obj_id_type. Enum options - METRICS_OBJ_ID_TYPE_VIRTUALSERVICE, METRICS_OBJ_ID_TYPE_SERVER, METRICS_OBJ_ID_TYPE_POOL, METRICS_OBJ_ID_TYPE_SERVICEENGINE, METRICS_OBJ_ID_TYPE_VIRTUALMACHINE, METRICS_OBJ_ID_TYPE_CONTROLLER, METRICS_OBJ_ID_TYPE_TENANT, METRICS_OBJ_ID_TYPE_CLUSTER, METRICS_OBJ_ID_TYPE_SE_INTERFACE. ObjIDType *string `json:"obj_id_type,omitempty"` // pool_id for the metric. PoolUUID *string `json:"pool_uuid,omitempty"` // Placeholder for description of property priority of obj type MetricsDataHeader field type str type boolean Priority *bool `json:"priority,omitempty"` // server ip port. Server *string `json:"server,omitempty"` // Service Engine ref or UUID. Field introduced in 17.2.8. ServiceengineUUID *string `json:"serviceengine_uuid,omitempty"` // statistics of the metric. Statistics *MetricStatistics `json:"statistics,omitempty"` // Tenant ref or UUID. TenantUUID *string `json:"tenant_uuid,omitempty"` // units of the column data. Enum options - METRIC_COUNT, BITS_PER_SECOND, MILLISECONDS, SECONDS, PER_SECOND, BYTES, PERCENT, KILO_BYTES, KILO_BYTES_PER_SECOND, BYTES_PER_SECOND, KILO_BITS_PER_SECOND, GIGA_BYTES, MEGA_BYTES, NORMALIZED, STRING, SEC, MIN, DAYS, KB, MB... Units *string `json:"units,omitempty"` }
MetricsDataHeader metrics data header swagger:model MetricsDataHeader
type MetricsDataSeries ¶
type MetricsDataSeries struct { // Placeholder for description of property data of obj type MetricsDataSeries field type str type object Data []*MetricsData `json:"data,omitempty"` // Placeholder for description of property header of obj type MetricsDataSeries field type str type object // Required: true Header *MetricsDataHeader `json:"header"` }
MetricsDataSeries metrics data series swagger:model MetricsDataSeries
type MetricsDbDiskEventDetails ¶
type MetricsDbDiskEventDetails struct { // metrics_deleted_tables of MetricsDbDiskEventDetails. MetricsDeletedTables []string `json:"metrics_deleted_tables,omitempty"` // Number of metrics_free_sz. // Required: true MetricsFreeSz *int64 `json:"metrics_free_sz"` // Number of metrics_quota. // Required: true MetricsQuota *int64 `json:"metrics_quota"` }
MetricsDbDiskEventDetails metrics db disk event details swagger:model MetricsDbDiskEventDetails
type MetricsDbQueueFullEventDetails ¶
type MetricsDbQueueFullEventDetails struct { // Number of high. High *int64 `json:"high,omitempty"` // Number of instanceport. Instanceport *int64 `json:"instanceport,omitempty"` // Number of low. Low *int64 `json:"low,omitempty"` // nodeid of MetricsDbQueueFullEventDetails. Nodeid *string `json:"nodeid,omitempty"` // period of MetricsDbQueueFullEventDetails. Period *string `json:"period,omitempty"` // Placeholder for description of property runtime of obj type MetricsDbQueueFullEventDetails field type str type object Runtime *MetricsDbRuntime `json:"runtime,omitempty"` // Number of watermark. Watermark *int64 `json:"watermark,omitempty"` }
MetricsDbQueueFullEventDetails metrics db queue full event details swagger:model MetricsDbQueueFullEventDetails
type MetricsDbQueueHealthyEventDetails ¶
type MetricsDbQueueHealthyEventDetails struct { // Number of high. High *int64 `json:"high,omitempty"` // Number of instanceport. Instanceport *int64 `json:"instanceport,omitempty"` // Number of low. Low *int64 `json:"low,omitempty"` // nodeid of MetricsDbQueueHealthyEventDetails. Nodeid *string `json:"nodeid,omitempty"` // period of MetricsDbQueueHealthyEventDetails. Period *string `json:"period,omitempty"` // Placeholder for description of property runtime of obj type MetricsDbQueueHealthyEventDetails field type str type object Runtime *MetricsDbRuntime `json:"runtime,omitempty"` // Number of watermark. Watermark *int64 `json:"watermark,omitempty"` }
MetricsDbQueueHealthyEventDetails metrics db queue healthy event details swagger:model MetricsDbQueueHealthyEventDetails
type MetricsDbRuntime ¶
type MetricsDbRuntime struct { // Number of db_num_client_queries. DbNumClientQueries *int32 `json:"db_num_client_queries,omitempty"` // Number of db_num_client_resp. DbNumClientResp *int32 `json:"db_num_client_resp,omitempty"` // Number of db_num_db_queries. DbNumDbQueries *int32 `json:"db_num_db_queries,omitempty"` // Number of db_num_db_resp. DbNumDbResp *int32 `json:"db_num_db_resp,omitempty"` // Number of db_num_oom. DbNumOom *int32 `json:"db_num_oom,omitempty"` // Number of db_queue_size. DbQueueSize *int32 `json:"db_queue_size,omitempty"` // Number of db_rum_queries. DbRumQueries *int32 `json:"db_rum_queries,omitempty"` // Number of db_rum_rows. DbRumRows *int32 `json:"db_rum_rows,omitempty"` }
MetricsDbRuntime metrics db runtime swagger:model MetricsDbRuntime
type MetricsDerivationData ¶
type MetricsDerivationData struct { // Enum options - METRICS_ALIAS. SUM_FIRST_N_DIVIDE_BY_LAST. SUM_BW_GAUGE. AVG_GET_POST_OTHER_LATENCY. APPDEX_ON_3_BUCKETS. APPDEX_ON_4_BUCKETS. SUM_GAUGE. SUM_N_METRICS. APPDEX_ON_5_BUCKETS. APPDEX_ON_6_BUCKETS. APPDEX_ON_CONNECTIONS. APPDEX_ON_2_BUCKETS. AVG_CLIENT_LATENCY. AVG_APPLICATION_LATENCY. MIN_N_METRICS. SUM_FIRST_N_DIVIDE_BY_LAST_PERCENTAGE. L4_CONNECTION_ERROR_PERCENTAGE. AVG_L4_CLIENT_LATENCY. CHECK_FOR_TRANSITIONS. SUBSTRACT_ALL_FROM_FIRST... // Required: true DerivationFn *string `json:"derivation_fn"` // Placeholder for description of property exclude_derived_metric of obj type MetricsDerivationData field type str type boolean ExcludeDerivedMetric *bool `json:"exclude_derived_metric,omitempty"` // Placeholder for description of property include_derivation_metrics of obj type MetricsDerivationData field type str type boolean IncludeDerivationMetrics *bool `json:"include_derivation_metrics,omitempty"` // Enum options - METRICS_TABLE_NONE. METRICS_TABLE_ANOMALY. METRICS_TABLE_CONTROLLER_STATS. METRICS_TABLE_HEALTH_SCORE. METRICS_TABLE_SE_STATS. METRICS_TABLE_VSERVER_L4_SERVER. METRICS_TABLE_VSERVER_L4_CLIENT. METRICS_TABLE_VSERVER_L7_CLIENT. METRICS_TABLE_VSERVER_L7_SERVER. METRICS_TABLE_RUM_PREAGG_BROWSER. METRICS_TABLE_RUM_PREAGG_COUNTRY. METRICS_TABLE_RUM_PREAGG_DEVTYPE. METRICS_TABLE_RUM_PREAGG_LANG. METRICS_TABLE_RUM_PREAGG_OS. METRICS_TABLE_RUM_PREAGG_URL. METRICS_TABLE_RUM_ANALYTICS. METRICS_TABLE_VM_STATS. METRICS_TABLE_RESOURCE_TIMING_DIM. METRICS_TABLE_RESOURCE_TIMING_BLOB. METRICS_TABLE_RUM_PREAGG_IPGROUP... JoinTables *string `json:"join_tables,omitempty"` // metric_ids of MetricsDerivationData. // Required: true MetricIds *string `json:"metric_ids"` // Placeholder for description of property result_has_additional_fields of obj type MetricsDerivationData field type str type boolean ResultHasAdditionalFields *bool `json:"result_has_additional_fields,omitempty"` // Field introduced in 17.2.8. SecondOrderDerivation *bool `json:"second_order_derivation,omitempty"` // Placeholder for description of property skip_backend_derivation of obj type MetricsDerivationData field type str type boolean SkipBackendDerivation *bool `json:"skip_backend_derivation,omitempty"` }
MetricsDerivationData metrics derivation data swagger:model MetricsDerivationData
type MetricsDimensionData ¶
type MetricsDimensionData struct { // Dimension Type. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. // Required: true Dimension *string `json:"dimension"` // Dimension ID. // Required: true DimensionID *string `json:"dimension_id"` }
MetricsDimensionData metrics dimension data swagger:model MetricsDimensionData
type MetricsEventThreshold ¶
type MetricsEventThreshold struct { // Type of the metrics event threshold. This value will decide which metric rule (or rules) use configured thresholds. Enum options - THRESHOLD_TYPE_STATIC, SE_CPU_THRESHOLD, SE_MEM_THRESHOLD, SE_DISK_THRESHOLD. Field introduced in 20.1.3. // Required: true MetricsEventThresholdType *string `json:"metrics_event_threshold_type"` // This value is used to reset the event state machine. Allowed values are 0-100. Field introduced in 20.1.3. ResetThreshold *float64 `json:"reset_threshold,omitempty"` // Threshold value for which event in raised. There can be multiple thresholds defined.Health score degrades when the the target is higher than this threshold. Allowed values are 0-100. Field introduced in 20.1.3. WatermarkThresholds []int64 `json:"watermark_thresholds,omitempty,omitempty"` }
MetricsEventThreshold metrics event threshold swagger:model MetricsEventThreshold
type MetricsMgrDebugFilter ¶
type MetricsMgrDebugFilter struct { // Set to ignore skip_eval_period field in metrics_anomaly_option. Field introduced in 20.1.4. DebugSkipEvalPeriod *string `json:"debug_skip_eval_period,omitempty"` // disable_hw_training of MetricsMgrDebugFilter. DisableHwTraining *string `json:"disable_hw_training,omitempty"` // entity of MetricsMgrDebugFilter. Entity *string `json:"entity,omitempty"` // setting to reduce the grace period for license expiry in hours. LicenseGracePeriod *string `json:"license_grace_period,omitempty"` // log_first_n of MetricsMgrDebugFilter. LogFirstN *string `json:"log_first_n,omitempty"` // logging_freq of MetricsMgrDebugFilter. LoggingFreq *string `json:"logging_freq,omitempty"` // metric_instance_id of MetricsMgrDebugFilter. MetricInstanceID *string `json:"metric_instance_id,omitempty"` // obj of MetricsMgrDebugFilter. Obj *string `json:"obj,omitempty"` // skip_cluster_map_check of MetricsMgrDebugFilter. SkipClusterMapCheck *string `json:"skip_cluster_map_check,omitempty"` // skip_metrics_db_writes of MetricsMgrDebugFilter. SkipMetricsDbWrites *string `json:"skip_metrics_db_writes,omitempty"` }
MetricsMgrDebugFilter metrics mgr debug filter swagger:model MetricsMgrDebugFilter
type MetricsMissingDataInterval ¶
type MetricsMissingDataInterval struct { // end of MetricsMissingDataInterval. // Required: true End *string `json:"end"` // start of MetricsMissingDataInterval. // Required: true Start *string `json:"start"` }
MetricsMissingDataInterval metrics missing data interval swagger:model MetricsMissingDataInterval
type MetricsQueryResponse ¶
type MetricsQueryResponse struct { // Unique object identifier of entity. EntityUUID *string `json:"entity_uuid,omitempty"` // returns the ID specified in the query. ID *string `json:"id,omitempty"` // Number of limit. Limit *int32 `json:"limit,omitempty"` // Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. MetricEntity *string `json:"metric_entity,omitempty"` // metric_id of MetricsQueryResponse. MetricID *string `json:"metric_id,omitempty"` // Placeholder for description of property series of obj type MetricsQueryResponse field type str type object Series []*MetricsDataSeries `json:"series,omitempty"` // start of MetricsQueryResponse. Start *string `json:"start,omitempty"` // Number of step. Step *int32 `json:"step,omitempty"` // stop of MetricsQueryResponse. Stop *string `json:"stop,omitempty"` }
MetricsQueryResponse metrics query response swagger:model MetricsQueryResponse
type MetricsRealTimeUpdate ¶
type MetricsRealTimeUpdate struct { // Real time metrics collection duration in minutes. 0 for infinite. Special values are 0 - 'infinite'. Unit is MIN. Duration *int32 `json:"duration,omitempty"` // Enables real time metrics collection. When deactivated, 6 hour view is the most granular the system will track. // Required: true Enabled *bool `json:"enabled"` }
MetricsRealTimeUpdate metrics real time update swagger:model MetricsRealTimeUpdate
type MgmtIPAccessControl ¶
type MgmtIPAccessControl struct { // Configure IP addresses to access controller using API. APIAccess *IPAddrMatch `json:"api_access,omitempty"` // Configure IP addresses to access controller using CLI Shell. ShellServerAccess *IPAddrMatch `json:"shell_server_access,omitempty"` // Configure IP addresses to access controller using SNMP. SnmpAccess *IPAddrMatch `json:"snmp_access,omitempty"` // Configure IP addresses to access controller using SSH. SSHAccess *IPAddrMatch `json:"ssh_access,omitempty"` // Configure IP addresses to access controller using sysint access. Field introduced in 18.1.3, 18.2.1. SysintAccess *IPAddrMatch `json:"sysint_access,omitempty"` }
MgmtIPAccessControl mgmt Ip access control swagger:model MgmtIpAccessControl
type MicroService ¶
type MicroService struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // application_name of MicroService. // Required: true ApplicationName *string `json:"application_name"` // Checksum of cloud configuration for Microservice. Internally set by cloud connector. Field introduced in 17.2.8. CloudConfigCksum *string `json:"cloud_config_cksum,omitempty"` // The list of containers for this microservice. Containers []*MicroServiceContainer `json:"containers,omitempty"` // Creator name. CreatedBy *string `json:"created_by,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Flag to indicate if container IP list is provided by cloud connectorThis is applicable for overlay cases. IPList *bool `json:"ip_list,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // orchestrator_name of MicroService. // Required: true OrchestratorName *string `json:"orchestrator_name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
MicroService micro service swagger:model MicroService
type MicroServiceAPIResponse ¶
type MicroServiceAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*MicroService `json:"results,omitempty"` }
MicroServiceAPIResponse micro service Api response swagger:model MicroServiceApiResponse
type MicroServiceContainer ¶
type MicroServiceContainer struct { // ID of the container. ContainerID *string `json:"container_id,omitempty"` // ID or name of the host where the container is. Host *string `json:"host,omitempty"` // IP Address of the container. // Required: true IP *IPAddr `json:"ip"` // Port nunber of the instance. Port *int32 `json:"port,omitempty"` // Marathon Task ID of the instance. TaskID *string `json:"task_id,omitempty"` }
MicroServiceContainer micro service container swagger:model MicroServiceContainer
type MicroServiceGroup ¶
type MicroServiceGroup struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Creator name. CreatedBy *string `json:"created_by,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Name of the MicroService group. // Required: true Name *string `json:"name"` // Configure MicroService(es). It is a reference to an object of type MicroService. ServiceRefs []string `json:"service_refs,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the MicroService group. UUID *string `json:"uuid,omitempty"` }
MicroServiceGroup micro service group swagger:model MicroServiceGroup
type MicroServiceGroupAPIResponse ¶
type MicroServiceGroupAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*MicroServiceGroup `json:"results,omitempty"` }
MicroServiceGroupAPIResponse micro service group Api response swagger:model MicroServiceGroupApiResponse
type MicroServiceMatch ¶
type MicroServiceMatch struct { // UUID of Micro Service group(s). It is a reference to an object of type MicroServiceGroup. // Required: true GroupRef *string `json:"group_ref"` // Criterion to use for Micro Service matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. // Required: true MatchCriteria *string `json:"match_criteria"` }
MicroServiceMatch micro service match swagger:model MicroServiceMatch
type NTPAuthenticationKey ¶
type NTPAuthenticationKey struct { // Message Digest Algorithm used for NTP authentication. Default is NTP_AUTH_ALGORITHM_MD5. Enum options - NTP_AUTH_ALGORITHM_MD5, NTP_AUTH_ALGORITHM_SHA1. Algorithm *string `json:"algorithm,omitempty"` // NTP Authentication key. // Required: true Key *string `json:"key"` // Key number to be assigned to the authentication-key. Allowed values are 1-65534. // Required: true KeyNumber *int32 `json:"key_number"` }
NTPAuthenticationKey n t p authentication key swagger:model NTPAuthenticationKey
type NTPConfiguration ¶
type NTPConfiguration struct { // NTP Authentication keys. NtpAuthenticationKeys []*NTPAuthenticationKey `json:"ntp_authentication_keys,omitempty"` // List of NTP server hostnames or IP addresses. NtpServerList []*IPAddr `json:"ntp_server_list,omitempty"` // List of NTP Servers. NtpServers []*NTPServer `json:"ntp_servers,omitempty"` }
NTPConfiguration n t p configuration swagger:model NTPConfiguration
type NTPServer ¶
type NTPServer struct { // Key number from the list of trusted keys used to authenticate this server. Allowed values are 1-65534. KeyNumber *int32 `json:"key_number,omitempty"` // IP Address of the NTP Server. // Required: true Server *IPAddr `json:"server"` }
NTPServer n t p server swagger:model NTPServer
type NatAddrInfo ¶
type NatAddrInfo struct { // Nat IP address. Field introduced in 18.2.3. NatIP *IPAddr `json:"nat_ip,omitempty"` // Nat IP address range. Field introduced in 18.2.3. NatIPRange *IPAddrRange `json:"nat_ip_range,omitempty"` }
NatAddrInfo nat addr info swagger:model NatAddrInfo
type NatMatchTarget ¶
type NatMatchTarget struct { // Destination IP of the packet. Field introduced in 18.2.3. DestinationIP *IPAddrMatch `json:"destination_ip,omitempty"` // Services like port-matching and protocol. Field introduced in 18.2.5. Services *ServiceMatch `json:"services,omitempty"` // Source IP of the packet. Field introduced in 18.2.3. SourceIP *IPAddrMatch `json:"source_ip,omitempty"` }
NatMatchTarget nat match target swagger:model NatMatchTarget
type NatPolicy ¶
type NatPolicy struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Creator name. Field introduced in 18.2.3. CreatedBy *string `json:"created_by,omitempty"` // Field introduced in 18.2.3. Description *string `json:"description,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the Nat policy. Field introduced in 18.2.3. Name *string `json:"name,omitempty"` // Nat policy Rules. Field introduced in 18.2.3. Rules []*NatRule `json:"rules,omitempty"` // It is a reference to an object of type Tenant. Field introduced in 18.2.3. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the Nat policy. Field introduced in 18.2.3. UUID *string `json:"uuid,omitempty"` }
NatPolicy nat policy swagger:model NatPolicy
type NatPolicyAPIResponse ¶
type NatPolicyAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*NatPolicy `json:"results,omitempty"` }
NatPolicyAPIResponse nat policy Api response swagger:model NatPolicyApiResponse
type NatPolicyAction ¶
type NatPolicyAction struct { // Pool of IP Addresses used for Nat. Field introduced in 18.2.5. NatInfo []*NatAddrInfo `json:"nat_info,omitempty"` // Nat Action Type. Enum options - NAT_POLICY_ACTION_TYPE_DYNAMIC_IP_PORT. Field introduced in 18.2.5. // Required: true Type *string `json:"type"` }
NatPolicyAction nat policy action swagger:model NatPolicyAction
type NatRule ¶
type NatRule struct { // Nat rule Action Information. Field introduced in 18.2.3. // Required: true Action *NatPolicyAction `json:"action"` // Creator name. Field introduced in 18.2.3. CreatedBy *string `json:"created_by,omitempty"` // Nat rule enable flag. Field introduced in 18.2.3. // Required: true Enable *bool `json:"enable"` // Nat rule Index. Field introduced in 18.2.3. // Required: true Index *int32 `json:"index"` // Nat rule Match Criteria. Field introduced in 18.2.3. // Required: true Match *NatMatchTarget `json:"match"` // Nat rule Name. Field introduced in 18.2.3. // Required: true Name *string `json:"name"` }
NatRule nat rule swagger:model NatRule
type Network ¶
type Network struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Key/value network attributes. Field introduced in 20.1.1. Attrs []*KeyValue `json:"attrs,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // Placeholder for description of property configured_subnets of obj type Network field type str type object ConfiguredSubnets []*Subnet `json:"configured_subnets,omitempty"` // Select the IP address management scheme for this Network. DhcpEnabled *bool `json:"dhcp_enabled,omitempty"` // When selected, excludes all discovered subnets in this network from consideration for virtual service placement. ExcludeDiscoveredSubnets *bool `json:"exclude_discovered_subnets,omitempty"` // Enable IPv6 auto configuration. Field introduced in 18.1.1. Ip6AutocfgEnabled *bool `json:"ip6_autocfg_enabled,omitempty"` // Key/value labels which can be used for Object Access Policy permission scoping. Field introduced in 18.2.7, 20.1.1. Labels []*KeyValue `json:"labels,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Placeholder for description of property synced_from_se of obj type Network field type str type boolean SyncedFromSe *bool `json:"synced_from_se,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Placeholder for description of property vcenter_dvs of obj type Network field type str type boolean VcenterDvs *bool `json:"vcenter_dvs,omitempty"` // It is a reference to an object of type VIMgrNWRuntime. // Read Only: true VimgrnwRef *string `json:"vimgrnw_ref,omitempty"` // It is a reference to an object of type VrfContext. VrfContextRef *string `json:"vrf_context_ref,omitempty"` }
Network network swagger:model Network
type NetworkAPIResponse ¶
type NetworkAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Network `json:"results,omitempty"` }
NetworkAPIResponse network Api response swagger:model NetworkApiResponse
type NetworkFilter ¶
type NetworkFilter struct { // It is a reference to an object of type VIMgrNWRuntime. // Required: true NetworkRef *string `json:"network_ref"` // server_filter of NetworkFilter. ServerFilter *string `json:"server_filter,omitempty"` }
NetworkFilter network filter swagger:model NetworkFilter
type NetworkProfile ¶
type NetworkProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // When enabled, Avi mirrors all TCP fastpath connections to standby. Applicable only in Legacy HA Mode. Field introduced in 18.1.3,18.2.1. ConnectionMirror *bool `json:"connection_mirror,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // The name of the network profile. // Required: true Name *string `json:"name"` // Placeholder for description of property profile of obj type NetworkProfile field type str type object // Required: true Profile *NetworkProfileUnion `json:"profile"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the network profile. UUID *string `json:"uuid,omitempty"` }
NetworkProfile network profile swagger:model NetworkProfile
type NetworkProfileAPIResponse ¶
type NetworkProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*NetworkProfile `json:"results,omitempty"` }
NetworkProfileAPIResponse network profile Api response swagger:model NetworkProfileApiResponse
type NetworkProfileUnion ¶
type NetworkProfileUnion struct { // Placeholder for description of property tcp_fast_path_profile of obj type NetworkProfileUnion field type str type object TCPFastPathProfile *TCPFastPathProfile `json:"tcp_fast_path_profile,omitempty"` // Placeholder for description of property tcp_proxy_profile of obj type NetworkProfileUnion field type str type object TCPProxyProfile *TCPProxyProfile `json:"tcp_proxy_profile,omitempty"` // Configure one of either proxy or fast path profiles. Enum options - PROTOCOL_TYPE_TCP_PROXY, PROTOCOL_TYPE_TCP_FAST_PATH, PROTOCOL_TYPE_UDP_FAST_PATH, PROTOCOL_TYPE_UDP_PROXY. Allowed in Basic(Allowed values- PROTOCOL_TYPE_TCP_PROXY,PROTOCOL_TYPE_TCP_FAST_PATH,PROTOCOL_TYPE_UDP_FAST_PATH) edition, Essentials(Allowed values- PROTOCOL_TYPE_TCP_FAST_PATH,PROTOCOL_TYPE_UDP_FAST_PATH) edition, Enterprise edition. // Required: true Type *string `json:"type"` // Placeholder for description of property udp_fast_path_profile of obj type NetworkProfileUnion field type str type object UDPFastPathProfile *UDPFastPathProfile `json:"udp_fast_path_profile,omitempty"` // Configure UDP Proxy network profile. Field introduced in 17.2.8, 18.1.3, 18.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. UDPProxyProfile *UDPProxyProfile `json:"udp_proxy_profile,omitempty"` }
NetworkProfileUnion network profile union swagger:model NetworkProfileUnion
type NetworkRuntime ¶
type NetworkRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Objects using static IPs in this network. Field introduced in 20.1.3. ObjUuids []string `json:"obj_uuids,omitempty"` // Use obj_uuids. Field deprecated in 20.1.3. SeUUID []string `json:"se_uuid,omitempty"` // Placeholder for description of property subnet_runtime of obj type NetworkRuntime field type str type object SubnetRuntime []*SubnetRuntime `json:"subnet_runtime,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
NetworkRuntime network runtime swagger:model NetworkRuntime
type NetworkRuntimeAPIResponse ¶
type NetworkRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*NetworkRuntime `json:"results,omitempty"` }
NetworkRuntimeAPIResponse network runtime Api response swagger:model NetworkRuntimeApiResponse
type NetworkSecurityMatchTarget ¶
type NetworkSecurityMatchTarget struct { // Placeholder for description of property client_ip of obj type NetworkSecurityMatchTarget field type str type object ClientIP *IPAddrMatch `json:"client_ip,omitempty"` // Matches the source port of incoming packets in the client side traffic. Field introduced in 20.1.3. ClientPort *PortMatchGeneric `json:"client_port,omitempty"` // Matches the geo information of incoming packets in the client side traffic. Field introduced in 21.1.1. Maximum of 1 items allowed. GeoMatches []*GeoMatch `json:"geo_matches,omitempty"` // Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. IPReputationType *IPReputationTypeMatch `json:"ip_reputation_type,omitempty"` // Placeholder for description of property microservice of obj type NetworkSecurityMatchTarget field type str type object Microservice *MicroServiceMatch `json:"microservice,omitempty"` // Placeholder for description of property vs_port of obj type NetworkSecurityMatchTarget field type str type object VsPort *PortMatch `json:"vs_port,omitempty"` }
NetworkSecurityMatchTarget network security match target swagger:model NetworkSecurityMatchTarget
type NetworkSecurityPolicy ¶
type NetworkSecurityPolicy struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Checksum of cloud configuration for Network Sec Policy. Internally set by cloud connector. CloudConfigCksum *string `json:"cloud_config_cksum,omitempty"` // Creator name. CreatedBy *string `json:"created_by,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Geo database. It is a reference to an object of type GeoDB. Field introduced in 21.1.1. GeoDbRef *string `json:"geo_db_ref,omitempty"` // IP reputation database. It is a reference to an object of type IPReputationDB. Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. IPReputationDbRef *string `json:"ip_reputation_db_ref,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Placeholder for description of property rules of obj type NetworkSecurityPolicy field type str type object Rules []*NetworkSecurityRule `json:"rules,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
NetworkSecurityPolicy network security policy swagger:model NetworkSecurityPolicy
type NetworkSecurityPolicyAPIResponse ¶
type NetworkSecurityPolicyAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*NetworkSecurityPolicy `json:"results,omitempty"` }
NetworkSecurityPolicyAPIResponse network security policy Api response swagger:model NetworkSecurityPolicyApiResponse
type NetworkSecurityPolicyActionRLParam ¶
type NetworkSecurityPolicyActionRLParam struct { // Maximum number of connections or requests or packets to be rate limited instantaneously. // Required: true BurstSize *int32 `json:"burst_size"` // Maximum number of connections or requests or packets per second. Allowed values are 1-4294967295. // Required: true MaxRate *int32 `json:"max_rate"` }
NetworkSecurityPolicyActionRLParam network security policy action r l param swagger:model NetworkSecurityPolicyActionRLParam
type NetworkSecurityRule ¶
type NetworkSecurityRule struct { // Enum options - NETWORK_SECURITY_POLICY_ACTION_TYPE_ALLOW, NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY, NETWORK_SECURITY_POLICY_ACTION_TYPE_RATE_LIMIT. Allowed in Basic(Allowed values- NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY) edition, Essentials(Allowed values- NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY) edition, Enterprise edition. // Required: true Action *string `json:"action"` // Time in minutes after which rule will be deleted. Allowed values are 1-4294967295. Special values are 0- 'blocked for ever'. Unit is MIN. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Age *int32 `json:"age,omitempty"` // Creator name. CreatedBy *string `json:"created_by,omitempty"` // Placeholder for description of property enable of obj type NetworkSecurityRule field type str type boolean // Required: true Enable *bool `json:"enable"` // Number of index. // Required: true Index *int32 `json:"index"` // Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Log *bool `json:"log,omitempty"` // Placeholder for description of property match of obj type NetworkSecurityRule field type str type object // Required: true Match *NetworkSecurityMatchTarget `json:"match"` // Name of the object. // Required: true Name *string `json:"name"` // Placeholder for description of property rl_param of obj type NetworkSecurityRule field type str type object RlParam *NetworkSecurityPolicyActionRLParam `json:"rl_param,omitempty"` }
NetworkSecurityRule network security rule swagger:model NetworkSecurityRule
type NetworkService ¶
type NetworkService struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // It is a reference to an object of type Cloud. Field introduced in 18.2.5. CloudRef *string `json:"cloud_ref,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the NetworkService. Field introduced in 18.2.5. // Required: true Name *string `json:"name"` // Routing Information of the NetworkService. Field introduced in 18.2.5. RoutingService *RoutingService `json:"routing_service,omitempty"` // Service Engine Group to which the service is applied. It is a reference to an object of type ServiceEngineGroup. Field introduced in 18.2.5. // Required: true SeGroupRef *string `json:"se_group_ref"` // Indicates the type of NetworkService. Enum options - ROUTING_SERVICE. Field introduced in 18.2.5. // Required: true ServiceType *string `json:"service_type"` // It is a reference to an object of type Tenant. Field introduced in 18.2.5. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the NetworkService. Field introduced in 18.2.5. UUID *string `json:"uuid,omitempty"` // VRF context to which the service is scoped. It is a reference to an object of type VrfContext. Field introduced in 18.2.5. // Required: true VrfRef *string `json:"vrf_ref"` }
NetworkService network service swagger:model NetworkService
type NetworkServiceAPIResponse ¶
type NetworkServiceAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*NetworkService `json:"results,omitempty"` }
NetworkServiceAPIResponse network service Api response swagger:model NetworkServiceApiResponse
type NetworkSubnetClash ¶
type NetworkSubnetClash struct { // ip_nw of NetworkSubnetClash. // Required: true IPNw *string `json:"ip_nw"` // networks of NetworkSubnetClash. Networks []string `json:"networks,omitempty"` }
NetworkSubnetClash network subnet clash swagger:model NetworkSubnetClash
type NetworkSubnetInfo ¶
type NetworkSubnetInfo struct { // Number of free. Free *int32 `json:"free,omitempty"` // network_name of NetworkSubnetInfo. NetworkName *string `json:"network_name,omitempty"` // Unique object identifier of network. NetworkUUID *string `json:"network_uuid,omitempty"` // Placeholder for description of property subnet of obj type NetworkSubnetInfo field type str type object Subnet *IPAddrPrefix `json:"subnet,omitempty"` // Number of total. Total *int32 `json:"total,omitempty"` // Enum options - STATIC_IPS_FOR_SE, STATIC_IPS_FOR_VIP, STATIC_IPS_FOR_VIP_AND_SE. Type *string `json:"type,omitempty"` // Number of used. Used *int32 `json:"used,omitempty"` }
NetworkSubnetInfo network subnet info swagger:model NetworkSubnetInfo
type NsxConfiguration ¶
type NsxConfiguration struct { // This prefix will be added to the names of all NSX objects created by Avi Controller. It should be unique across all the Avi Controller clusters. Field introduced in 17.1.1. // Required: true AviNsxPrefix *string `json:"avi_nsx_prefix"` // The hostname or IP address of the NSX MGr. Field introduced in 17.1.1. // Required: true NsxManagerName *string `json:"nsx_manager_name"` // The password Avi Vantage will use when authenticating with NSX Mgr. Field introduced in 17.1.1. // Required: true NsxManagerPassword *string `json:"nsx_manager_password"` // The username Avi Vantage will use when authenticating with NSX Mgr. Field introduced in 17.1.1. // Required: true NsxManagerUsername *string `json:"nsx_manager_username"` // The interval (in secs) with which Avi Controller polls the NSX Manager for updates. Field introduced in 17.1.1. Unit is SECONDS. // Required: true NsxPollTime *int32 `json:"nsx_poll_time"` }
NsxConfiguration nsx configuration swagger:model NsxConfiguration
type NsxtConfiguration ¶
type NsxtConfiguration struct { // Automatically create DFW rules for VirtualService in NSX-T Manager. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Enterprise edition. AutomateDfwRules *bool `json:"automate_dfw_rules,omitempty"` // Domain where NSGroup objects belongs to. Field introduced in 20.1.1. DomainID *string `json:"domain_id,omitempty"` // Enforcement point is where the rules of a policy to apply. Field introduced in 20.1.1. EnforcementpointID *string `json:"enforcementpoint_id,omitempty"` // Management network segment to use for Avi Service Engines. Field introduced in 20.1.1. // Required: true ManagementSegment *Tier1LogicalRouterInfo `json:"management_segment"` // Credentials to access NSX-T manager. It is a reference to an object of type CloudConnectorUser. Field introduced in 20.1.1. // Required: true NsxtCredentialsRef *string `json:"nsxt_credentials_ref"` // NSX-T manager hostname or IP address. Field introduced in 20.1.1. // Required: true NsxtURL *string `json:"nsxt_url"` // Site where transport zone belongs to. Field introduced in 20.1.1. SiteID *string `json:"site_id,omitempty"` // Nsxt tier1 segment configuration for Avi Service Engine data path. Field introduced in 20.1.1. // Required: true Tier1SegmentConfig *NsxtTier1SegmentConfig `json:"tier1_segment_config"` // Network zone where nodes can talk via overlay. Virtual IPs and Service Engines will belong to this zone. Field introduced in 20.1.1. // Required: true TransportZone *string `json:"transport_zone"` }
NsxtConfiguration nsxt configuration swagger:model NsxtConfiguration
type NsxtCredentials ¶
type NsxtCredentials struct { // Password to talk to Nsx-t manager. Field introduced in 20.1.1. Password *string `json:"password,omitempty"` // Username to talk to Nsx-t manager. Field introduced in 20.1.1. Username *string `json:"username,omitempty"` }
NsxtCredentials nsxt credentials swagger:model NsxtCredentials
type NsxtDatastores ¶
type NsxtDatastores struct { // List of shared datastores. Field introduced in 20.1.2. Allowed in Basic edition, Enterprise edition. DsIds []string `json:"ds_ids,omitempty"` // Include or Exclude. Field introduced in 20.1.2. Allowed in Basic edition, Enterprise edition. Include *bool `json:"include,omitempty"` }
NsxtDatastores nsxt datastores swagger:model NsxtDatastores
type NsxtHosts ¶
type NsxtHosts struct { // List of transport nodes. Field introduced in 20.1.1. HostIds []string `json:"host_ids,omitempty"` // Include or Exclude. Field introduced in 20.1.1. Include *bool `json:"include,omitempty"` }
NsxtHosts nsxt hosts swagger:model NsxtHosts
type NsxtImageDetails ¶
type NsxtImageDetails struct { // Cloud Id. Field introduced in 20.1.1. CcID *string `json:"cc_id,omitempty"` // Error message. Field introduced in 20.1.1. ErrorString *string `json:"error_string,omitempty"` // Image version. Field introduced in 20.1.1. ImageVersion *string `json:"image_version,omitempty"` // VC url. Field introduced in 20.1.1. VcURL *string `json:"vc_url,omitempty"` }
NsxtImageDetails nsxt image details swagger:model NsxtImageDetails
type NsxtSegmentRuntime ¶
type NsxtSegmentRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Nsxt segment belongs to cloud. It is a reference to an object of type Cloud. Field introduced in 20.1.1. CloudRef *string `json:"cloud_ref,omitempty"` // V6 DHCP ranges configured in Nsxt. Field introduced in 20.1.1. Dhcp6Ranges []string `json:"dhcp6_ranges,omitempty"` // IP address management scheme for this Segment associated network. Field introduced in 20.1.1. DhcpEnabled *bool `json:"dhcp_enabled,omitempty"` // DHCP ranges configured in Nsxt. Field introduced in 20.1.1. DhcpRanges []string `json:"dhcp_ranges,omitempty"` // Segment object name. Field introduced in 20.1.1. Name *string `json:"name,omitempty"` // Network Name. Field introduced in 20.1.1. NwName *string `json:"nw_name,omitempty"` // Corresponding network object in Avi. It is a reference to an object of type Network. Field introduced in 20.1.1. NwRef *string `json:"nw_ref,omitempty"` // Opaque network Id. Field introduced in 20.1.1. OpaqueNetworkID *string `json:"opaque_network_id,omitempty"` // Segment Gateway. Field introduced in 20.1.1. SegmentGw *string `json:"segment_gw,omitempty"` // V6 segment Gateway. Field introduced in 20.1.1. SegmentGw6 *string `json:"segment_gw6,omitempty"` // Segment Id. Field introduced in 20.1.1. SegmentID *string `json:"segment_id,omitempty"` // Segment name. Field introduced in 20.1.1. Segname *string `json:"segname,omitempty"` // Segment Cidr. Field introduced in 20.1.1. Subnet *string `json:"subnet,omitempty"` // V6 Segment Cidr. Field introduced in 20.1.1. Subnet6 *string `json:"subnet6,omitempty"` // Nsxt segment belongs to tenant. It is a reference to an object of type Tenant. Field introduced in 20.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // Tier1 router Id. Field introduced in 20.1.1. Tier1ID *string `json:"tier1_id,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Uuid. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` // Corresponding vrf context object in Avi. It is a reference to an object of type VrfContext. Field introduced in 20.1.1. VrfContextRef *string `json:"vrf_context_ref,omitempty"` }
NsxtSegmentRuntime nsxt segment runtime swagger:model NsxtSegmentRuntime
type NsxtSegmentRuntimeAPIResponse ¶
type NsxtSegmentRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*NsxtSegmentRuntime `json:"results,omitempty"` }
NsxtSegmentRuntimeAPIResponse nsxt segment runtime Api response swagger:model NsxtSegmentRuntimeApiResponse
type NsxtSetup ¶
type NsxtSetup struct { // cc_id of NsxtSetup. CcID *string `json:"cc_id,omitempty"` // reason of NsxtSetup. Reason *string `json:"reason,omitempty"` // status of NsxtSetup. Status *string `json:"status,omitempty"` // transportzone_id of NsxtSetup. TransportzoneID *string `json:"transportzone_id,omitempty"` }
NsxtSetup nsxt setup swagger:model NsxtSetup
type NsxtTier1SegmentAutomaticMode ¶
type NsxtTier1SegmentAutomaticMode struct { // Uber IP subnet for the logical segments created automatically by Avi controller. Field introduced in 20.1.1. // Required: true NsxtSegmentSubnet *IPAddrPrefix `json:"nsxt_segment_subnet"` // The number of SE data vNic's that can be connected to the Avi logical segment. Field introduced in 20.1.1. NumSePerSegment *int32 `json:"num_se_per_segment,omitempty"` // Tier1 logical router IDs. Field introduced in 20.1.1. Minimum of 1 items required. Tier1LrIds []string `json:"tier1_lr_ids,omitempty"` }
NsxtTier1SegmentAutomaticMode nsxt tier1 segment automatic mode swagger:model NsxtTier1SegmentAutomaticMode
type NsxtTier1SegmentConfig ¶
type NsxtTier1SegmentConfig struct { // Avi controller creates and manages logical segments for a Tier-1 LR. Field introduced in 20.1.1. Allowed in Basic edition, Enterprise edition. Automatic *NsxtTier1SegmentAutomaticMode `json:"automatic,omitempty"` // Avi Admin selects an available logical segment (created by NSX-T admin) associated with a Tier-1 LR. Field introduced in 20.1.1. Manual *NsxtTier1SegmentManualMode `json:"manual,omitempty"` // Config Mode for selecting the placement logical segments for Avi ServiceEngine data path. Enum options - TIER1_SEGMENT_MANUAL, TIER1_SEGMENT_AUTOMATIC. Field introduced in 20.1.1. Allowed in Basic(Allowed values- TIER1_SEGMENT_MANUAL) edition, Enterprise edition. // Required: true SegmentConfigMode *string `json:"segment_config_mode"` }
NsxtTier1SegmentConfig nsxt tier1 segment config swagger:model NsxtTier1SegmentConfig
type NsxtTier1SegmentManualMode ¶
type NsxtTier1SegmentManualMode struct { // Tier1 logical router placement information. Field introduced in 20.1.1. Minimum of 1 items required. Maximum of 128 items allowed. Tier1Lrs []*Tier1LogicalRouterInfo `json:"tier1_lrs,omitempty"` }
NsxtTier1SegmentManualMode nsxt tier1 segment manual mode swagger:model NsxtTier1SegmentManualMode
type NtlmLog ¶
type NtlmLog struct { // Set to true, if request is detected to be NTLM. Field introduced in 20.1.3. NtlmDetected *bool `json:"ntlm_detected,omitempty"` // Set the NTLM Status. Enum options - NTLM_AUTHENTICATION_SUCCESS, NTLM_UNAUTHORIZED, NTLM_NEGOTIATION, NTLM_AUTHENTICATION_FAILURE, NTLM_AUTHENTICATED_REQUESTS. Field introduced in 20.1.3. NtlmStatus *string `json:"ntlm_status,omitempty"` }
NtlmLog ntlm log swagger:model NtlmLog
type NuageSDNController ¶
type NuageSDNController struct { // nuage_organization of NuageSDNController. NuageOrganization *string `json:"nuage_organization,omitempty"` // nuage_password of NuageSDNController. NuagePassword *string `json:"nuage_password,omitempty"` // Number of nuage_port. NuagePort *int32 `json:"nuage_port,omitempty"` // nuage_username of NuageSDNController. NuageUsername *string `json:"nuage_username,omitempty"` // Nuage VSD host name or IP address. NuageVsdHost *string `json:"nuage_vsd_host,omitempty"` // Domain to be used for SE creation. SeDomain *string `json:"se_domain,omitempty"` // Enterprise to be used for SE creation. SeEnterprise *string `json:"se_enterprise,omitempty"` // Network to be used for SE creation. SeNetwork *string `json:"se_network,omitempty"` // Policy Group to be used for SE creation. SePolicyGroup *string `json:"se_policy_group,omitempty"` // User to be used for SE creation. SeUser *string `json:"se_user,omitempty"` // Zone to be used for SE creation. SeZone *string `json:"se_zone,omitempty"` }
NuageSDNController nuage s d n controller swagger:model NuageSDNController
type OCICredentials ¶
type OCICredentials struct { // API key with respect to the Public Key. Field introduced in 18.2.1,18.1.3. Fingerprint *string `json:"fingerprint,omitempty"` // Private Key file (pem file) content. Field introduced in 18.2.1,18.1.3. KeyContent *string `json:"key_content,omitempty"` // Pass phrase for the key. Field introduced in 18.2.1,18.1.3. PassPhrase *string `json:"pass_phrase,omitempty"` // Oracle Cloud Id for the User. Field introduced in 18.2.1,18.1.3. User *string `json:"user,omitempty"` }
OCICredentials o c i credentials swagger:model OCICredentials
type OCISetup ¶
type OCISetup struct { // cc_id of OCISetup. CcID *string `json:"cc_id,omitempty"` // compartment_id of OCISetup. CompartmentID *string `json:"compartment_id,omitempty"` // reason of OCISetup. Reason *string `json:"reason,omitempty"` // status of OCISetup. Status *string `json:"status,omitempty"` // tenancy of OCISetup. Tenancy *string `json:"tenancy,omitempty"` // vcn_id of OCISetup. VcnID *string `json:"vcn_id,omitempty"` }
OCISetup o c i setup swagger:model OCISetup
type OCSPConfig ¶
type OCSPConfig struct { // Describes the Time Interval after which the next OCSP job needs to be scheduled in case of the OCSP job failures. Allowed values are 60-86400. Field introduced in 20.1.1. Unit is SEC. FailedOcspJobsRetryInterval *int32 `json:"failed_ocsp_jobs_retry_interval,omitempty"` // Maximum number of times the failed OCSP jobs can be scheduled. Field introduced in 20.1.1. MaxTries *int32 `json:"max_tries,omitempty"` // Interval between the OCSP queries. Allowed values are 60-31536000. Field introduced in 20.1.1. Unit is SEC. OcspReqInterval *int32 `json:"ocsp_req_interval,omitempty"` // Time in seconds that the system waits for a reply from the OCSP responder before dropping the connection. Field introduced in 20.1.1. Unit is SEC. OcspRespTimeout *int32 `json:"ocsp_resp_timeout,omitempty"` // List of Responder URLs configured by user to do failover/override the AIA extension contained in the OCSP responder's SSL/TLS certificate. Field introduced in 20.1.1. ResponderURLLists []string `json:"responder_url_lists,omitempty"` // Describes the type of action to take with the Responder URLs. Enum options - OCSP_RESPONDER_URL_FAILOVER, OCSP_RESPONDER_URL_OVERRIDE. Field introduced in 20.1.1. URLAction *string `json:"url_action,omitempty"` }
OCSPConfig o c s p config swagger:model OCSPConfig
type OCSPResponseInfo ¶
type OCSPResponseInfo struct { // Revocation status of the certificate. Enum options - OCSP_CERTSTATUS_GOOD, OCSP_CERTSTATUS_REVOKED, OCSP_CERTSTATUS_UNKNOWN. Field introduced in 20.1.1. // Required: true // Read Only: true CertStatus *string `json:"cert_status"` // The time at or before which newer information will be available about the status of the certificate. Field introduced in 20.1.1. // Read Only: true NextUpdate *string `json:"next_update,omitempty"` // The OCSP Responder URL from which the response is received. Field introduced in 20.1.1. // Required: true // Read Only: true OcspRespFromResponderURL *string `json:"ocsp_resp_from_responder_url"` // Signed OCSP response received from the CA's OCSP Responder. Field introduced in 20.1.1. // Required: true // Read Only: true OcspResponse *string `json:"ocsp_response"` // The reason for the revocation of the certificate. Enum options - OCSP_REVOCATION_REASON_UNSPECIFIED, OCSP_REVOCATION_REASON_KEY_COMPROMISE, OCSP_REVOCATION_REASON_CA_COMPROMISE, OCSP_REVOCATION_REASON_AFFILIATION_CHANGED, OCSP_REVOCATION_REASON_SUPERSEDED, OCSP_REVOCATION_REASON_CESSATION_OF_OPERATION, OCSP_REVOCATION_REASON_CERTIFICATE_HOLD, OCSP_REVOCATION_REASON_REMOVE_FROM_CRL, OCSP_REVOCATION_REASON_PRIVILEGE_WITHDRAWN, OCSP_REVOCATION_REASON_AA_COMPROMISE. Field introduced in 20.1.1. // Read Only: true RevocationReason *string `json:"revocation_reason,omitempty"` // ISO 8601 compatible timestamp at which the certificate was revoked or placed on hold. Field introduced in 20.1.1. // Read Only: true RevocationTime *string `json:"revocation_time,omitempty"` // The most recent time at which the status being indicated is known by the OCSP Responder to have been correct. Field introduced in 20.1.1. // Read Only: true ThisUpdate *string `json:"this_update,omitempty"` }
OCSPResponseInfo o c s p response info swagger:model OCSPResponseInfo
type OShiftK8SConfiguration ¶
type OShiftK8SConfiguration struct { // Sync frequency in seconds with frameworks. AppSyncFrequency *int32 `json:"app_sync_frequency,omitempty"` // Auto assign FQDN to a virtual service if a valid FQDN is not configured. Field introduced in 17.2.8. AutoAssignFqdn *bool `json:"auto_assign_fqdn,omitempty"` // Avi Linux bridge subnet on OpenShift/K8s nodes. AviBridgeSubnet *IPAddrPrefix `json:"avi_bridge_subnet,omitempty"` // UUID of the UCP CA TLS cert and key. It is a reference to an object of type SSLKeyAndCertificate. CaTLSKeyAndCertificateRef *string `json:"ca_tls_key_and_certificate_ref,omitempty"` // UUID of the client TLS cert and key instead of service account token. One of client certificate or token is required. It is a reference to an object of type SSLKeyAndCertificate. ClientTLSKeyAndCertificateRef *string `json:"client_tls_key_and_certificate_ref,omitempty"` // Openshift/K8S Cluster ID used to uniquely map same named namespaces as tenants in Avi. In order to use more than one OpenShift/K8S cloud on this controller, cluster_tag has to be unique across these clouds. Changing cluster_tag is disruptive as all virtual services in the cloud will be recreated. Field introduced in 17.2.5. ClusterTag *string `json:"cluster_tag,omitempty"` // Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService. By default, ports 80, 8080, 443, 8443 are considered HTTP. ContainerPortMatchHTTPService *bool `json:"container_port_match_http_service,omitempty"` // Directory to mount to check for core dumps on Service Engines. This will be mapped read only to /var/crash on any new Service Engines. This is a disruptive change. CoredumpDirectory *string `json:"coredump_directory,omitempty"` // If there is no explicit east_west_placement field in virtualservice configuration, treat service as a East-West service; default services such a OpenShift API server do not have virtualservice configuration. DefaultServiceAsEastWestService *bool `json:"default_service_as_east_west_service,omitempty"` DefaultSharedVirtualservice *OshiftSharedVirtualService `json:"default_shared_virtualservice,omitempty"` // Disable auto service sync for back end services. DisableAutoBackendServiceSync *bool `json:"disable_auto_backend_service_sync,omitempty"` // Disable auto service sync for front end services. DisableAutoFrontendServiceSync *bool `json:"disable_auto_frontend_service_sync,omitempty"` // Disable auto sync for GSLB services. Field introduced in 17.1.3. DisableAutoGsSync *bool `json:"disable_auto_gs_sync,omitempty"` // Disable SE creation. DisableAutoSeCreation *bool `json:"disable_auto_se_creation,omitempty"` // Host Docker server UNIX socket endpoint. Field introduced in 17.2.14, 18.1.5, 18.2.1. DockerEndpoint *string `json:"docker_endpoint,omitempty"` // Docker registry for ServiceEngine image. DockerRegistrySe *DockerRegistry `json:"docker_registry_se,omitempty"` // Match against this prefix when placing east-west VSs on SEs . EastWestPlacementSubnet *IPAddrPrefix `json:"east_west_placement_subnet,omitempty"` // Enable Kubernetes event subscription. EnableEventSubscription *bool `json:"enable_event_subscription,omitempty"` // Knob to turn on adding of HTTP drop rules for host and path combinations in incoming request header, specified as part of Ingress/Route spec. The default state is to enable this behavior. Note Toggling this knob only affects any new routes/ingresses, existing routes/ingresses present in Avi will continue to function as-is. Field introduced in 18.2.6. EnableRouteIngressHardening *bool `json:"enable_route_ingress_hardening,omitempty"` // Enable proxy ARP from Host interface for Front End proxies. FeproxyVipsEnableProxyArp *bool `json:"feproxy_vips_enable_proxy_arp,omitempty"` // Optional fleet remote endpoint if fleet is used for SE deployment. Field deprecated in 17.2.13,18.1.5,18.2.1. FleetEndpoint *string `json:"fleet_endpoint,omitempty"` // List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80, 8080, 443 and 8443. HTTPContainerPorts []int64 `json:"http_container_ports,omitempty,omitempty"` // Do not sync applications only for ingress that have these exclude attributes configured. Field introduced in 17.2.15, 18.1.5, 18.2.1. IngExcludeAttributes []*IngAttribute `json:"ing_exclude_attributes,omitempty"` // Sync applications only for ingress objects that have these include attributes configured. Default values are populated for this field if not provided. The default value are 'attribute' 'kubernetes.io/ingress.class', 'value' 'avi'. Field introduced in 17.2.15, 18.1.5, 18.2.1. IngIncludeAttributes []*IngAttribute `json:"ing_include_attributes,omitempty"` // Perform Layer4 (TCP/UDP) health monitoring even for Layer7 (HTTP) Pools. L4HealthMonitoring *bool `json:"l4_health_monitoring,omitempty"` // List of OpenShift/Kubernetes master nodes; In case of a load balanced OpenShift/K8S cluster, use Virtual IP of the cluster. Each node is of the form node 8443 or http //node 8080. If scheme is not provided, https is assumed. MasterNodes []string `json:"master_nodes,omitempty"` // OpenShift/K8S Node label to be used as OpenShift/K8S Node's availability zone in a dual availability zone deployment. ServiceEngines belonging to the availability zone will be rebooted during a manual DR failover. NodeAvailabilityZoneLabel *string `json:"node_availability_zone_label,omitempty"` // Syncing of applications is disabled only for namespaces/projects that have these exclude attributes configured. If there are apps synced already for these namespaces, they will be removed from Avi. Field introduced in 17.1.9,17.2.3. NsExcludeAttributes []*MesosAttribute `json:"ns_exclude_attributes,omitempty"` // Sync applications only for namespaces/projects that have these include attributes configured. Field introduced in 17.1.9,17.2.3. NsIncludeAttributes []*MesosAttribute `json:"ns_include_attributes,omitempty"` // Nuage Overlay SDN Controller information. Field deprecated in 17.2.13,18.1.5,18.2.1. NuageController *NuageSDNController `json:"nuage_controller,omitempty"` // Enables sharding of Routes and Ingresses to this number (if non zero) of virtual services in the admin tenant per SEGroup. Sharding is done by hashing on the namespace of the Ingress/Route object. This knob is valid only if shared_virtualservice_namespace flag is set. Field introduced in 18.2.5. NumShards *int32 `json:"num_shards,omitempty"` // Override Service Ports with well known ports (80/443) for http/https Route/Ingress VirtualServices. Field introduced in 17.2.12,18.1.3. OverrideServicePorts *bool `json:"override_service_ports,omitempty"` // Persistent Volume Claim name to be used for persistent storage for Avi service engines. This could be used in scenarios where host based volumes are ephemeral. Refer https //kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims for more details on the usage of this field. Field introduced in 18.2.6. PersistentVolumeClaim *string `json:"persistent_volume_claim,omitempty"` // Routes support adding routes to a particular namespace routing table in Openshift/K8s cluster. Each route is a combination of subnet and nexthop ip address or nexthop interface name, and a enum type is used to distinguish an entry in the host (default behaviour) or in the container/pod or in other namespace. This knob should be enabled in the following cases 1. Forwarding the network packets to the same network interface from where it came from in the OpenShift/K8s node. 2. OpenShift/K8s Node connected to the Internet via multiple network interfaces on different networks/ISPs.3. Handling North-South traffic originating from with in the node when the default gateway for outgoing traffic of vs is configured.4. Handling the container/pod traffic by adding the routes in the container/pod. Field introduced in 18.2.6. Routes []*RouteInfo `json:"routes,omitempty"` RoutesShareVirtualservice *bool `json:"routes_share_virtualservice,omitempty"` // Cluster uses overlay based SDN. Enable this flag if cluster uses a overlay based SDN for OpenShift, Flannel, Weave, Nuage. Disable for routed mode. SdnOverlay *bool `json:"sdn_overlay,omitempty"` // Use SSH/Pod for SE deployment. Enum options - SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD. SeDeploymentMethod *string `json:"se_deployment_method,omitempty"` // Exclude hosts with attributes for SE creation. SeExcludeAttributes []*MesosAttribute `json:"se_exclude_attributes,omitempty"` // OpenShift/K8S secret name to be used for private docker repos when deploying SE as a Pod. Reference Link https //kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/. Field introduced in 17.2.13,18.1.3,18.2.1. SeImagePullSecret *string `json:"se_image_pull_secret,omitempty"` // Create SEs just on hosts with include attributes. SeIncludeAttributes []*MesosAttribute `json:"se_include_attributes,omitempty"` // Kubernetes namespace to be used for deploying Avi service engines. This namespace is used to create daemonsets, service accounts, etc. for Avi only use. Setting this value is a disruptive operation and assumes the namespace exists in kubernetes. 'default' namespace is picked if this field is unset. Field introduced in 18.2.6. SeNamespace *string `json:"se_namespace,omitempty"` // Match SE Pod tolerations against taints of OpenShift/K8S nodes https //kubernetes.io/docs/concepts/configuration/taint-and-toleration/. Field introduced in 17.2.14, 18.1.5, 18.2.1. SePodTolerations []*PodToleration `json:"se_pod_tolerations,omitempty"` // Priority class for AVI SEs when running as pods. User is expected to have the priority class (with this name) created in Kubernetes, beforehand. If the priority class doesn't exist while assigning this field, the SE pods may not start. If empty no priority class will be used for deploying SE pods (default behaviour). Field introduced in 18.2.6. SePriorityClass *string `json:"se_priority_class,omitempty"` // Restart ServiceEngines by batch on ServiceEngineGroup updates (cpu, memory..etc). Field introduced in 17.2.15, 18.1.5, 18.2.1. SeRestartBatchSize *int32 `json:"se_restart_batch_size,omitempty"` // Restart ServiceEngines forcely if VirtualServices failed to migrate to another SE. Field introduced in 17.2.15, 18.1.5, 18.2.1. SeRestartForce *bool `json:"se_restart_force,omitempty"` // New SE spawn rate per minute. Field deprecated in 17.2.13,18.1.5,18.2.1. SeSpawnRate *int32 `json:"se_spawn_rate,omitempty"` // Host volume to be used as a disk for Avi SE, This is a disruptive change. SeVolume *string `json:"se_volume,omitempty"` // Allow Avi Vantage to create SecurityContextConstraints and ServiceAccounts which allow Egress Pods to run in privileged mode in an Openshift environment. Enabling this would exclude egress services from 'disable_auto_backend_service_sync' (if set) behaviour. Note Access credentials must have cluster-admin role privileges. Field introduced in 17.1.1. SecureEgressMode *bool `json:"secure_egress_mode,omitempty"` // Authorization token for service account instead of client certificate. One of client certificate or token is required. ServiceAccountToken *string `json:"service_account_token,omitempty"` // Perform service port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Field deprecated in 17.2.11,18.1.2. ServicePortMatchHTTPService *bool `json:"service_port_match_http_service,omitempty"` // Prefix to be used for Shard VS name when num_shards knob is non zero. Format for Shard VS name will be <shard_prefix>-<idx>-CloudName-SEGroupName. Field introduced in 18.2.5. ShardPrefix *string `json:"shard_prefix,omitempty"` SharedVirtualserviceNamespace *bool `json:"shared_virtualservice_namespace,omitempty"` // Parameters for SSH SE deployment. Field deprecated in 17.1.1. SSHSeDeployment *SSHSeDeployment `json:"ssh_se_deployment,omitempty"` // Cloud connector user uuid for SSH to hosts. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.1.1. SSHUserRef *string `json:"ssh_user_ref,omitempty"` // Allow the not_ready_addresses in the kubernetes endpoint object to be added as servers in the AVI pool object. Field introduced in 18.2.5. SyncNotReadyAddresses *bool `json:"sync_not_ready_addresses,omitempty"` // If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se. UseControllerImage *bool `json:"use_controller_image,omitempty"` // Use OpenShift/Kubernetes resource definition and annotations as single-source-of-truth. Any changes made in Avi Controller via UI or CLI will be overridden by values provided in annotations. Field introduced in 17.2.13, 18.1.4, 18.2.1. UseResourceDefinitionAsSsot *bool `json:"use_resource_definition_as_ssot,omitempty"` // Enable VirtualService placement on Service Engines on nodes with scheduling disabled. When false, Service Engines are disabled on nodes where scheduling is disabled. UseSchedulingDisabledNodes *bool `json:"use_scheduling_disabled_nodes,omitempty"` // Use Cluster IP of service as VIP for East-West services; This option requires that kube proxy is disabled on all nodes. UseServiceClusterIPAsEwVip *bool `json:"use_service_cluster_ip_as_ew_vip,omitempty"` // VirtualService default gateway if multiple nics are present in the host. Field introduced in 18.2.2. VipDefaultGateway *IPAddr `json:"vip_default_gateway,omitempty"` }
OShiftK8SConfiguration o shift k8 s configuration swagger:model OShiftK8SConfiguration
type ObjSyncConfig ¶
type ObjSyncConfig struct { // SE CPU limit for InterSE Object Distribution. Allowed values are 15-80. Field introduced in 20.1.3. Unit is PERCENT. ObjsyncCPULimit *int32 `json:"objsync_cpu_limit,omitempty"` // Hub election interval for InterSE Object Distribution. Allowed values are 30-300. Field introduced in 20.1.3. Unit is SEC. ObjsyncHubElectInterval *int32 `json:"objsync_hub_elect_interval,omitempty"` // Reconcile interval for InterSE Object Distribution. Allowed values are 1-120. Field introduced in 20.1.3. Unit is SEC. ObjsyncReconcileInterval *int32 `json:"objsync_reconcile_interval,omitempty"` }
ObjSyncConfig obj sync config swagger:model ObjSyncConfig
type OpenStackAPIVersionCheckFailure ¶
type OpenStackAPIVersionCheckFailure struct { // Cloud UUID. Field introduced in 20.1.1. CcID *string `json:"cc_id,omitempty"` // Cloud name. Field introduced in 20.1.1. CcName *string `json:"cc_name,omitempty"` // Failure reason containing expected API version and actual version. Field introduced in 20.1.1. ErrorString *string `json:"error_string,omitempty"` }
OpenStackAPIVersionCheckFailure open stack Api version check failure swagger:model OpenStackApiVersionCheckFailure
type OpenStackClusterSetup ¶
type OpenStackClusterSetup struct { // admin_tenant of OpenStackClusterSetup. AdminTenant *string `json:"admin_tenant,omitempty"` // auth_url of OpenStackClusterSetup. AuthURL *string `json:"auth_url,omitempty"` // cc_id of OpenStackClusterSetup. CcID *string `json:"cc_id,omitempty"` // error_string of OpenStackClusterSetup. ErrorString *string `json:"error_string,omitempty"` // keystone_host of OpenStackClusterSetup. // Required: true KeystoneHost *string `json:"keystone_host"` // Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Privilege *string `json:"privilege,omitempty"` }
OpenStackClusterSetup open stack cluster setup swagger:model OpenStackClusterSetup
type OpenStackConfiguration ¶
type OpenStackConfiguration struct { // OpenStack admin tenant (or project) information. For Keystone v3, provide the project information in project@domain format. Domain need not be specified if the project belongs to the 'Default' domain. // Required: true AdminTenant *string `json:"admin_tenant"` // admin-tenant's UUID in OpenStack. AdminTenantUUID *string `json:"admin_tenant_uuid,omitempty"` // If false, allowed-address-pairs extension will not be used. . AllowedAddressPairs *bool `json:"allowed_address_pairs,omitempty"` // If true, an anti-affinity policy will be applied to all SEs of a SE-Group, else no such policy will be applied. AntiAffinity *bool `json:"anti_affinity,omitempty"` // Auth URL for connecting to keystone. If this is specified, any value provided for keystone_host is ignored. AuthURL *string `json:"auth_url,omitempty"` // If false, metadata service will be used instead of config-drive functionality to retrieve SE VM metadata. ConfigDrive *bool `json:"config_drive,omitempty"` // When set to True, the VIP and Data ports will be programmed to set virtual machine interface disable-policy. Please refer Contrail documentation for more on disable-policy. Field introduced in 18.1.2. ContrailDisablePolicy *bool `json:"contrail_disable_policy,omitempty"` // Contrail VNC endpoint url (example http //10.10.10.100 8082). By default, 'http //' scheme and 8082 port will be used if not provided in the url. ContrailEndpoint *string `json:"contrail_endpoint,omitempty"` // Enable Contrail plugin mode. (deprecated). ContrailPlugin *bool `json:"contrail_plugin,omitempty"` // Custom image properties to be set on a Service Engine image. Only hw_vif_multiqueue_enabled property is supported. Other properties will be ignored. Field introduced in 18.2.7, 20.1.1. CustomSeImageProperties []*Property `json:"custom_se_image_properties,omitempty"` // If True, allow selection of networks marked as 'external' for management, vip or data networks. ExternalNetworks *bool `json:"external_networks,omitempty"` // Free unused floating IPs. FreeFloatingips *bool `json:"free_floatingips,omitempty"` // Default hypervisor type, only KVM is supported. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Hypervisor *string `json:"hypervisor,omitempty"` // Custom properties per hypervisor type. Field introduced in 17.2.1. HypervisorProperties []*OpenStackHypervisorProperties `json:"hypervisor_properties,omitempty"` // If OS_IMG_FMT_RAW, use RAW images else use QCOW2 for KVM. Enum options - OS_IMG_FMT_AUTO, OS_IMG_FMT_QCOW2, OS_IMG_FMT_VMDK, OS_IMG_FMT_RAW, OS_IMG_FMT_FLAT. ImgFormat *string `json:"img_format,omitempty"` // Import keystone tenants list into Avi. ImportKeystoneTenants *bool `json:"import_keystone_tenants,omitempty"` // Allow self-signed certificates when communicating with https service endpoints. Insecure *bool `json:"insecure,omitempty"` // If True, interface-secondary-ips method will be used for VIP association. Field deprecated in 18.1.2. IntfSecIps *bool `json:"intf_sec_ips,omitempty"` // Keystone's hostname or IP address. (Deprecated) Use auth_url instead. KeystoneHost *string `json:"keystone_host,omitempty"` // If True, map Avi 'admin' tenant to the admin_tenant of the Cloud. Else map Avi 'admin' to OpenStack 'admin' tenant. MapAdminToCloudadmin *bool `json:"map_admin_to_cloudadmin,omitempty"` // Avi Management network name or cidr. // Required: true MgmtNetworkName *string `json:"mgmt_network_name"` // Management network UUID. MgmtNetworkUUID *string `json:"mgmt_network_uuid,omitempty"` // If True, embed owner info in VIP port 'name', else embed owner info in 'device_id' field. NameOwner *bool `json:"name_owner,omitempty"` // If True, enable neutron rbac discovery of networks shared across tenants/projects. NeutronRbac *bool `json:"neutron_rbac,omitempty"` // Field deprecated in 20.1.1. NuageOrganization *string `json:"nuage_organization,omitempty"` // Field deprecated in 20.1.1. NuagePassword *string `json:"nuage_password,omitempty"` // Field deprecated in 20.1.1. NuagePort *int32 `json:"nuage_port,omitempty"` // Field deprecated in 20.1.1. NuageUsername *string `json:"nuage_username,omitempty"` // Applicable only if allowed-address-pairs is disabled or unusable. VIP placement uses Nuage virtualIp if true, else redirectionTarget. Field deprecated in 20.1.1. Field introduced in 17.2.3. NuageVirtualip *bool `json:"nuage_virtualip,omitempty"` // Nuage VSD host name or IP address. Field deprecated in 20.1.1. NuageVsdHost *string `json:"nuage_vsd_host,omitempty"` // The password Avi Vantage will use when authenticating to Keystone. Password *string `json:"password,omitempty"` // If true, port-security extension (if detected) will be used instead of security-groups, allowed-address-pairs or interface-secondary-ips. If false, port-security extension is skipped. Field deprecated in 20.1.1. PortSecurity *bool `json:"port_security,omitempty"` // Access privilege. Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. // Required: true Privilege *string `json:"privilege"` // LBaaS provider name. ProvName []string `json:"prov_name,omitempty"` // A tenant can normally use its own networks and any networks shared with it. In addition, this setting provides extra networks that are usable by tenants. Field introduced in 18.1.2. ProviderVipNetworks []*OpenStackVipNetwork `json:"provider_vip_networks,omitempty"` // Region name. Region *string `json:"region,omitempty"` // Defines the mapping from OpenStack role names to avi local role names. For an OpenStack role, this mapping is consulted only if there is no local Avi role with the same name as the OpenStack role. This is an ordered list and only the first matching entry is used. You can use '*' to match all OpenStack role names. RoleMapping []*OpenStackRoleMapping `json:"role_mapping,omitempty"` // This field has been generalized for all clouds and has been renamed to se_group_template_uuid. It is a reference to an object of type ServiceEngineGroup. Field deprecated in 18.2.5. SeGroupRef *string `json:"se_group_ref,omitempty"` // If false, security-groups extension will not be used. . SecurityGroups *bool `json:"security_groups,omitempty"` // If true, then SEs will be created in the appropriate tenants, else SEs will be created in the admin_tenant. TenantSe *bool `json:"tenant_se,omitempty"` // Deprecated, please use provider_vip_networks. Field deprecated in 18.2.2. Field introduced in 17.1.1. UsableNetworkUuids []string `json:"usable_network_uuids,omitempty"` // If admin URLs are either inaccessible or not to be accessed from Avi Controller, then set this to False. UseAdminURL *bool `json:"use_admin_url,omitempty"` // Use internalURL for OpenStack endpoints instead of the default publicURL endpoints. UseInternalEndpoints *bool `json:"use_internal_endpoints,omitempty"` // Use keystone for user authentication. UseKeystoneAuth *bool `json:"use_keystone_auth,omitempty"` // If True, use nuage vip as device_owner of VIP ports, else use neutron LOADBALANCER. Field deprecated in 20.1.1. Field introduced in 17.2.1. UseNuagevip *bool `json:"use_nuagevip,omitempty"` // The username Avi Vantage will use when authenticating to Keystone. For Keystone v3, provide the user information in user@domain format, unless that user belongs to the Default domain. // Required: true Username *string `json:"username"` // If enabled, program SE security group with ingress rule to allow SSH (port 22) access from 0.0.0.0/0. Field deprecated in 17.1.5. Field introduced in 17.1.3. WildcardAccess *bool `json:"wildcard_access,omitempty"` }
OpenStackConfiguration open stack configuration swagger:model OpenStackConfiguration
type OpenStackHypervisorProperties ¶
type OpenStackHypervisorProperties struct { // Hypervisor type. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Field introduced in 17.2.1. // Required: true Hypervisor *string `json:"hypervisor"` // Custom properties to be associated with the SE image in Glance for this hypervisor type. Field introduced in 17.2.1. ImageProperties []*Property `json:"image_properties,omitempty"` }
OpenStackHypervisorProperties open stack hypervisor properties swagger:model OpenStackHypervisorProperties
type OpenStackIPChange ¶
type OpenStackIPChange struct { // error_string of OpenStackIpChange. ErrorString *string `json:"error_string,omitempty"` // Placeholder for description of property ip of obj type OpenStackIpChange field type str type object // Required: true IP *IPAddr `json:"ip"` // mac_addr of OpenStackIpChange. MacAddr *string `json:"mac_addr,omitempty"` // Unique object identifier of port. PortUUID *string `json:"port_uuid,omitempty"` // Unique object identifier of se_vm. SeVMUUID *string `json:"se_vm_uuid,omitempty"` }
OpenStackIPChange open stack Ip change swagger:model OpenStackIpChange
type OpenStackLbPluginOp ¶
type OpenStackLbPluginOp struct { // cc_id of OpenStackLbPluginOp. CcID *string `json:"cc_id,omitempty"` // command of OpenStackLbPluginOp. // Required: true Command *string `json:"command"` // detail of OpenStackLbPluginOp. Detail *string `json:"detail,omitempty"` // Number of elapsed. Elapsed *int32 `json:"elapsed,omitempty"` // id of OpenStackLbPluginOp. // Required: true ID *string `json:"id"` // prov of OpenStackLbPluginOp. // Required: true Prov *string `json:"prov"` // result of OpenStackLbPluginOp. Result *string `json:"result,omitempty"` }
OpenStackLbPluginOp open stack lb plugin op swagger:model OpenStackLbPluginOp
type OpenStackLbProvAuditCheck ¶
type OpenStackLbProvAuditCheck struct { // cc_id of OpenStackLbProvAuditCheck. CcID *string `json:"cc_id,omitempty"` // detail of OpenStackLbProvAuditCheck. Detail *string `json:"detail,omitempty"` // Number of elapsed. Elapsed *int32 `json:"elapsed,omitempty"` // id of OpenStackLbProvAuditCheck. // Required: true ID *string `json:"id"` // result of OpenStackLbProvAuditCheck. Result *string `json:"result,omitempty"` // tenant of OpenStackLbProvAuditCheck. // Required: true Tenant *string `json:"tenant"` // user of OpenStackLbProvAuditCheck. // Required: true User *string `json:"user"` }
OpenStackLbProvAuditCheck open stack lb prov audit check swagger:model OpenStackLbProvAuditCheck
type OpenStackRoleMapping ¶
type OpenStackRoleMapping struct { // Role name in Avi. // Required: true AviRole *string `json:"avi_role"` // Role name in OpenStack. // Required: true OsRole *string `json:"os_role"` }
OpenStackRoleMapping open stack role mapping swagger:model OpenStackRoleMapping
type OpenStackSeVMChange ¶
type OpenStackSeVMChange struct { // error_string of OpenStackSeVmChange. ErrorString *string `json:"error_string,omitempty"` // Unique object identifier of se_vm. SeVMUUID *string `json:"se_vm_uuid,omitempty"` }
OpenStackSeVMChange open stack se Vm change swagger:model OpenStackSeVmChange
type OpenStackSyncServices ¶
type OpenStackSyncServices struct { // error_string of OpenStackSyncServices. ErrorString *string `json:"error_string,omitempty"` // Unique object identifier of se_vm. SeVMUUID *string `json:"se_vm_uuid,omitempty"` }
OpenStackSyncServices open stack sync services swagger:model OpenStackSyncServices
type OpenStackVipNetwork ¶
type OpenStackVipNetwork struct { // Neutron network UUID. Field introduced in 18.1.2. OsNetworkUUID *string `json:"os_network_uuid,omitempty"` // UUIDs of OpenStack tenants that should be allowed to use the specified Neutron network for VIPs. Use '*' to make this network available to all tenants. Field introduced in 18.1.2. OsTenantUuids []string `json:"os_tenant_uuids,omitempty"` }
OpenStackVipNetwork open stack vip network swagger:model OpenStackVipNetwork
type OpenStackVnicChange ¶
type OpenStackVnicChange struct { // error_string of OpenStackVnicChange. ErrorString *string `json:"error_string,omitempty"` // mac_addrs of OpenStackVnicChange. MacAddrs []string `json:"mac_addrs,omitempty"` // networks of OpenStackVnicChange. Networks []string `json:"networks,omitempty"` // Unique object identifier of se_vm. // Required: true SeVMUUID *string `json:"se_vm_uuid"` }
OpenStackVnicChange open stack vnic change swagger:model OpenStackVnicChange
type OpenstackLogin ¶
type OpenstackLogin struct { // admin_tenant of OpenstackLogin. AdminTenant *string `json:"admin_tenant,omitempty"` // auth_url of OpenstackLogin. AuthURL *string `json:"auth_url,omitempty"` // keystone_host of OpenstackLogin. KeystoneHost *string `json:"keystone_host,omitempty"` // password of OpenstackLogin. // Required: true Password *string `json:"password"` // region of OpenstackLogin. Region *string `json:"region,omitempty"` // username of OpenstackLogin. // Required: true Username *string `json:"username"` }
OpenstackLogin openstack login swagger:model OpenstackLogin
type OperationalStatus ¶
type OperationalStatus struct { // Placeholder for description of property last_changed_time of obj type OperationalStatus field type str type object LastChangedTime *TimeStamp `json:"last_changed_time,omitempty"` // reason of OperationalStatus. Reason []string `json:"reason,omitempty"` // Number of reason_code. ReasonCode *int64 `json:"reason_code,omitempty"` // reason_code_string of OperationalStatus. ReasonCodeString *string `json:"reason_code_string,omitempty"` // Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL. State *string `json:"state,omitempty"` }
OperationalStatus operational status swagger:model OperationalStatus
type OpsHistory ¶
type OpsHistory struct { // Duration of Upgrade operation in seconds. Field introduced in 20.1.4. Unit is SEC. Duration *int32 `json:"duration,omitempty"` // End time of Upgrade operation. Field introduced in 20.1.4. EndTime *string `json:"end_time,omitempty"` // Upgrade operation performed. Enum options - UPGRADE, PATCH, ROLLBACK, ROLLBACKPATCH, SEGROUP_RESUME. Field introduced in 20.1.4. Ops *string `json:"ops,omitempty"` // Patch after the upgrade operation. . Field introduced in 20.1.4. PatchVersion *string `json:"patch_version,omitempty"` // ServiceEngineGroup/SE events for upgrade operation. Field introduced in 20.1.4. SeUpgradeEvents []*SeUpgradeEvents `json:"se_upgrade_events,omitempty"` // SeGroup status for the upgrade operation. Field introduced in 20.1.4. SegStatus *SeGroupStatus `json:"seg_status,omitempty"` // Start time of Upgrade operation. Field introduced in 20.1.4. StartTime *string `json:"start_time,omitempty"` // Upgrade operation status. Field introduced in 20.1.4. State *UpgradeOpsState `json:"state,omitempty"` // Controller events for Upgrade operation. Field introduced in 20.1.4. UpgradeEvents []*EventMap `json:"upgrade_events,omitempty"` // Image after the upgrade operation. Field introduced in 20.1.4. Version *string `json:"version,omitempty"` }
OpsHistory ops history swagger:model OpsHistory
type OshiftDockerRegistryMetaData ¶
type OshiftDockerRegistryMetaData struct { // Namespace for the ServiceEngine image to be hosted in Openshift Integrated registry. RegistryNamespace *string `json:"registry_namespace,omitempty"` // Name of the Integrated registry Service in Openshift. RegistryService *string `json:"registry_service,omitempty"` // Static VIP for 'docker-registry' service in Openshift if Avi is proxying for this service.This VIP should be outside the cluster IP subnet in Kubernetes and within the subnet configured (but outside the available pool of IPs) in the East West IPAM profile configuration for this Cloud. For example, if kubernetes cluster VIP range is 172.30.0.0/16 and subnet configured in East West IPAM profile is 172.50.0.0/16, then 172.50.0.2 can be used for this vip and IP pool can start from 172.50.0.3 onwards. Use this static VIP in '--insecure-registry <this-vip> 5000' docker config if using an insecure registry or add this to the list of IPs/hostnames when generating certificates if using a secure TLS registry. RegistryVip *IPAddr `json:"registry_vip,omitempty"` }
OshiftDockerRegistryMetaData oshift docker registry meta data swagger:model OshiftDockerRegistryMetaData
type OshiftSharedVirtualService ¶
type OshiftSharedVirtualService struct { // Required: true VirtualserviceName *string `json:"virtualservice_name"` }
OshiftSharedVirtualService oshift shared virtual service swagger:model OshiftSharedVirtualService
type OutOfBandRequestLog ¶
type OutOfBandRequestLog struct { // Logs for out-of-band requests sent from the DataScript. Field introduced in 20.1.3. DsReqLogs []*DSRequestLog `json:"ds_req_logs,omitempty"` }
OutOfBandRequestLog out of band request log swagger:model OutOfBandRequestLog
type PGDeploymentRule ¶
type PGDeploymentRule struct { // metric_id of PGDeploymentRule. MetricID *string `json:"metric_id,omitempty"` // Enum options - CO_EQ, CO_GT, CO_GE, CO_LT, CO_LE, CO_NE. Operator *string `json:"operator,omitempty"` // metric threshold that is used as the pass fail. If it is not provided then it will simply compare it with current pool vs new pool. Threshold *float64 `json:"threshold,omitempty"` }
PGDeploymentRule p g deployment rule swagger:model PGDeploymentRule
type PGDeploymentRuleResult ¶
type PGDeploymentRuleResult struct { // Metric value that is used as the pass fail. If it is not provided then it will simply compare it with current pool vs new pool. MetricValue *float64 `json:"metric_value,omitempty"` // Whether rule passed or failed. Result *bool `json:"result,omitempty"` // Rule used for evaluation. // Required: true Rule *PGDeploymentRule `json:"rule"` }
PGDeploymentRuleResult p g deployment rule result swagger:model PGDeploymentRuleResult
type PKIprofile ¶
type PKIprofile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // List of Certificate Authorities (Root and Intermediate) trusted that is used for certificate validation. CaCerts []*SSLCertificate `json:"ca_certs,omitempty"` // Creator name. CreatedBy *string `json:"created_by,omitempty"` // When enabled, Avi will verify via CRL checks that certificates in the trust chain have not been revoked. CrlCheck *bool `json:"crl_check,omitempty"` // Certificate Revocation Lists. Crls []*CRL `json:"crls,omitempty"` // When enabled, Avi will not trust Intermediate and Root certs presented by a client. Instead, only the chain certs configured in the Certificate Authority section will be used to verify trust of the client's cert. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Special default for Basic edition is true, Essentials edition is true, Enterprise is False. IgnorePeerChain *bool `json:"ignore_peer_chain,omitempty"` // This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. . Field introduced in 17.1.3. IsFederated *bool `json:"is_federated,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the PKI Profile. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // When enabled, Avi will only validate the revocation status of the leaf certificate using CRL. To enable validation for the entire chain, disable this option and provide all the relevant CRLs. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. ValidateOnlyLeafCrl *bool `json:"validate_only_leaf_crl,omitempty"` }
PKIprofile p k iprofile swagger:model PKIProfile
type PKIprofileAPIResponse ¶
type PKIprofileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*PKIprofile `json:"results,omitempty"` }
PKIprofileAPIResponse p k iprofile Api response swagger:model PKIProfileApiResponse
type PaaLog ¶
type PaaLog struct { // PingAccess Agent cache was used for authentication. Field introduced in 18.2.3. CacheHit *bool `json:"cache_hit,omitempty"` // The PingAccess server required the client request body for authentication. Field introduced in 18.2.3. ClientRequestBodySent *bool `json:"client_request_body_sent,omitempty"` // Logs for each request sent to PA server to completeauthentication for the initial request. Field introduced in 18.2.3. RequestLogs []*PaaRequestLog `json:"request_logs,omitempty"` }
PaaLog paa log swagger:model PaaLog
type PaaRequestLog ¶
type PaaRequestLog struct { // Response headers received from PingAccess server. Field introduced in 18.2.3. HeadersReceivedFromServer *string `json:"headers_received_from_server,omitempty"` // Request headers sent to PingAccess server. Field introduced in 18.2.3. HeadersSentToServer *string `json:"headers_sent_to_server,omitempty"` // The http version of the request. Field introduced in 18.2.3. HTTPVersion *string `json:"http_version,omitempty"` // The http method of the request. Field introduced in 18.2.3. Method *string `json:"method,omitempty"` // The name of the pool that was used for the request. Field introduced in 18.2.3. PoolName *string `json:"pool_name,omitempty"` // The response code received from the PingAccess server. Field introduced in 18.2.3. ResponseCode *int32 `json:"response_code,omitempty"` // The IP of the server that was sent the request. Field introduced in 18.2.3. ServerIP *int32 `json:"server_ip,omitempty"` // Number of servers tried during server reselect before the response is sent back. Field introduced in 18.2.3. ServersTried *int32 `json:"servers_tried,omitempty"` // The uri of the request. Field introduced in 18.2.3. URIPath *string `json:"uri_path,omitempty"` }
PaaRequestLog paa request log swagger:model PaaRequestLog
type PackageDetails ¶
type PackageDetails struct { // This contains build related information. Field introduced in 18.2.6. Build *BuildInfo `json:"build,omitempty"` // MD5 checksum over the entire package. Field introduced in 18.2.6. Hash *string `json:"hash,omitempty"` // Patch related necessary information. Field introduced in 18.2.6. Patch *PatchInfo `json:"patch,omitempty"` // Path of the package in the repository. Field introduced in 18.2.6. Path *string `json:"path,omitempty"` }
PackageDetails package details swagger:model PackageDetails
type ParamInfo ¶
type ParamInfo struct { // Number of hits for a param. Field introduced in 20.1.1. ParamHits *int64 `json:"param_hits,omitempty"` // Param name. Field introduced in 20.1.1. ParamKey *string `json:"param_key,omitempty"` // Various param size and its respective hit count. Field introduced in 20.1.1. ParamSizeClasses []*ParamSizeClass `json:"param_size_classes,omitempty"` // Various param type and its respective hit count. Field introduced in 20.1.1. ParamTypeClasses []*ParamTypeClass `json:"param_type_classes,omitempty"` }
ParamInfo param info swagger:model ParamInfo
type ParamSizeClass ¶
type ParamSizeClass struct { // Field introduced in 20.1.1. Hits *int64 `json:"hits,omitempty"` // Enum options - EMPTY, SMALL, MEDIUM, LARGE, UNLIMITED. Field introduced in 20.1.1. Len *string `json:"len,omitempty"` }
ParamSizeClass param size class swagger:model ParamSizeClass
type ParamTypeClass ¶
type ParamTypeClass struct { // Field introduced in 20.1.1. Hits *int64 `json:"hits,omitempty"` // Enum options - PARAM_FLAG, PARAM_DIGITS, PARAM_HEXDIGITS, PARAM_WORD, PARAM_SAFE_TEXT, PARAM_SAFE_TEXT_MULTILINE, PARAM_TEXT, PARAM_TEXT_MULTILINE, PARAM_ALL. Field introduced in 20.1.1. Type *string `json:"type,omitempty"` }
ParamTypeClass param type class swagger:model ParamTypeClass
type PatchData ¶
type PatchData struct { // Image path of current patch image. . Field introduced in 18.2.10, 20.1.1. PatchImagePath *string `json:"patch_image_path,omitempty"` // Image uuid for identifying the patch. It is a reference to an object of type Image. Field introduced in 18.2.8, 20.1.1. PatchImageRef *string `json:"patch_image_ref,omitempty"` // Patch version. Field introduced in 18.2.8, 20.1.1. PatchVersion *string `json:"patch_version,omitempty"` }
PatchData patch data swagger:model PatchData
type PatchInfo ¶
type PatchInfo struct { // Patch type describes the controller or se patch type. Field introduced in 18.2.6. PatchType *string `json:"patch_type,omitempty"` // This variable tells whether reboot has to be performed. Field introduced in 18.2.6. Reboot *bool `json:"reboot,omitempty"` // This variable is for full list of patch reboot details. Field introduced in 18.2.8, 20.1.1. RebootList []*RebootData `json:"reboot_list,omitempty"` }
PatchInfo patch info swagger:model PatchInfo
type PathMatch ¶
type PathMatch struct { // Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE. MatchCase *string `json:"match_case,omitempty"` // Criterion to use for matching the path in the HTTP request URI. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Basic(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Essentials(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Enterprise edition. // Required: true MatchCriteria *string `json:"match_criteria"` // String values. MatchStr []string `json:"match_str,omitempty"` // UUID of the *string group(s). It is a reference to an object of type StringGroup. StringGroupRefs []string `json:"string_group_refs,omitempty"` }
PathMatch path match swagger:model PathMatch
type PerformanceLimits ¶
type PerformanceLimits struct { // The maximum number of concurrent client conections allowed to the Virtual Service. MaxConcurrentConnections *int32 `json:"max_concurrent_connections,omitempty"` // The maximum throughput per second for all clients allowed through the client side of the Virtual Service. MaxThroughput *int32 `json:"max_throughput,omitempty"` }
PerformanceLimits performance limits swagger:model PerformanceLimits
type Permission ¶
type Permission struct { // Enum options - PERMISSION_CONTROLLER. PERMISSION_INTERNAL. PERMISSION_VIRTUALSERVICE. PERMISSION_POOL. PERMISSION_HEALTHMONITOR. PERMISSION_NETWORKPROFILE. PERMISSION_APPLICATIONPROFILE. PERMISSION_HTTPPOLICYSET. PERMISSION_IPADDRGROUP. PERMISSION_STRINGGROUP. PERMISSION_SSLPROFILE. PERMISSION_SSLKEYANDCERTIFICATE. PERMISSION_NETWORKSECURITYPOLICY. PERMISSION_APPLICATIONPERSISTENCEPROFILE. PERMISSION_ANALYTICSPROFILE. PERMISSION_VSDATASCRIPTSET. PERMISSION_TENANT. PERMISSION_PKIPROFILE. PERMISSION_AUTHPROFILE. PERMISSION_CLOUD... Resource *string `json:"resource,omitempty"` // Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Type *string `json:"type,omitempty"` }
Permission permission swagger:model Permission
type PersistenceFilter ¶
type PersistenceFilter struct { // Persistence cookie. PersistenceCookie *string `json:"persistence_cookie,omitempty"` // Placeholder for description of property persistence_end_ip of obj type PersistenceFilter field type str type object PersistenceEndIP *IPAddr `json:"persistence_end_ip,omitempty"` // Placeholder for description of property persistence_ip of obj type PersistenceFilter field type str type object PersistenceIP *IPAddr `json:"persistence_ip,omitempty"` // Number of persistence_mask. PersistenceMask *int32 `json:"persistence_mask,omitempty"` // Placeholder for description of property server_end_ip of obj type PersistenceFilter field type str type object ServerEndIP *IPAddr `json:"server_end_ip,omitempty"` // Placeholder for description of property server_ip of obj type PersistenceFilter field type str type object ServerIP *IPAddr `json:"server_ip,omitempty"` // Number of server_mask. ServerMask *int32 `json:"server_mask,omitempty"` // Number of server_port. ServerPort *int32 `json:"server_port,omitempty"` }
PersistenceFilter persistence filter swagger:model PersistenceFilter
type PingAccessAgent ¶
type PingAccessAgent struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Field introduced in 18.2.3. Description *string `json:"description,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the PingAccess Agent. Field introduced in 18.2.3. // Required: true Name *string `json:"name"` // Pool containing a primary PingAccess Server, as well as any failover servers included in the agent.properties file. It is a reference to an object of type Pool. Field introduced in 18.2.3. // Required: true PingaccessPoolRef *string `json:"pingaccess_pool_ref"` // The ip and port of the primary PingAccess Server. Field introduced in 18.2.3. // Required: true PrimaryServer *PoolServer `json:"primary_server"` // PingAccessAgent's agent.properties file generated by PingAccess server. Field introduced in 18.2.3. // Required: true PropertiesFileData *string `json:"properties_file_data"` // It is a reference to an object of type Tenant. Field introduced in 18.2.3. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the PingAccess Agent. Field introduced in 18.2.3. UUID *string `json:"uuid,omitempty"` }
PingAccessAgent ping access agent swagger:model PingAccessAgent
type PingAccessAgentAPIResponse ¶
type PingAccessAgentAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*PingAccessAgent `json:"results,omitempty"` }
PingAccessAgentAPIResponse ping access agent Api response swagger:model PingAccessAgentApiResponse
type PlacementNetwork ¶
type PlacementNetwork struct { // It is a reference to an object of type Network. // Required: true NetworkRef *string `json:"network_ref"` // Placeholder for description of property subnet of obj type PlacementNetwork field type str type object // Required: true Subnet *IPAddrPrefix `json:"subnet"` }
PlacementNetwork placement network swagger:model PlacementNetwork
type PlacementScopeConfig ¶
type PlacementScopeConfig struct { // List of shared datastores to include or exclude. Field introduced in 20.1.2. Allowed in Basic edition, Enterprise edition. NsxtDatastores *NsxtDatastores `json:"nsxt_datastores,omitempty"` // List of transport nodes include or exclude. Field introduced in 20.1.1. NsxtHosts *NsxtHosts `json:"nsxt_hosts,omitempty"` // Folder to place all the Service Engine virtual machines in vCenter. Field introduced in 20.1.1. VcenterFolder *string `json:"vcenter_folder,omitempty"` // VCenter server configuration. It is a reference to an object of type VCenterServer. Field introduced in 20.1.1. // Required: true VcenterRef *string `json:"vcenter_ref"` }
PlacementScopeConfig placement scope config swagger:model PlacementScopeConfig
type PodToleration ¶
type PodToleration struct { // Effect to match. Enum options - NO_SCHEDULE, PREFER_NO_SCHEDULE, NO_EXECUTE. Field introduced in 17.2.14, 18.1.5, 18.2.1. Effect *string `json:"effect,omitempty"` // Key to match. Field introduced in 17.2.14, 18.1.5, 18.2.1. Key *string `json:"key,omitempty"` // Operator to match. Enum options - EQUAL, EXISTS. Field introduced in 17.2.14, 18.1.5, 18.2.1. Operator *string `json:"operator,omitempty"` // Pods that tolerate the taint with a specified toleration_seconds remain bound for the specified amount of time. Field introduced in 17.2.14, 18.1.5, 18.2.1. Unit is SECONDS. TolerationSeconds *int32 `json:"toleration_seconds,omitempty"` // Value to match. Field introduced in 17.2.14, 18.1.5, 18.2.1. Value *string `json:"value,omitempty"` }
PodToleration pod toleration swagger:model PodToleration
type Pool ¶
type Pool struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of container cloud application that constitutes A pool in a A-B pool configuration, if different from VS app. Field deprecated in 18.1.2. APool *string `json:"a_pool,omitempty"` // A/B pool configuration. Field deprecated in 18.1.2. AbPool *AbPool `json:"ab_pool,omitempty"` // Priority of this pool in a A-B pool pair. Internally used. Field deprecated in 18.1.2. AbPriority *int32 `json:"ab_priority,omitempty"` // Determines analytics settings for the pool. Field introduced in 18.1.5, 18.2.1. AnalyticsPolicy *PoolAnalyticsPolicy `json:"analytics_policy,omitempty"` // Specifies settings related to analytics. It is a reference to an object of type AnalyticsProfile. Field introduced in 18.1.4,18.2.1. AnalyticsProfileRef *string `json:"analytics_profile_ref,omitempty"` // Synchronize Cisco APIC EPG members with pool servers. ApicEpgName *string `json:"apic_epg_name,omitempty"` // Persistence will ensure the same user sticks to the same server for a desired duration of time. It is a reference to an object of type ApplicationPersistenceProfile. ApplicationPersistenceProfileRef *string `json:"application_persistence_profile_ref,omitempty"` // If configured then Avi will trigger orchestration of pool server creation and deletion. It is a reference to an object of type AutoScaleLaunchConfig. AutoscaleLaunchConfigRef *string `json:"autoscale_launch_config_ref,omitempty"` // Network Ids for the launch configuration. AutoscaleNetworks []string `json:"autoscale_networks,omitempty"` // Reference to Server Autoscale Policy. It is a reference to an object of type ServerAutoScalePolicy. AutoscalePolicyRef *string `json:"autoscale_policy_ref,omitempty"` // Inline estimation of capacity of servers. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. CapacityEstimation *bool `json:"capacity_estimation,omitempty"` // The maximum time-to-first-byte of a server. Allowed values are 1-5000. Special values are 0 - 'Automatic'. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. CapacityEstimationTtfbThresh *int32 `json:"capacity_estimation_ttfb_thresh,omitempty"` // Checksum of cloud configuration for Pool. Internally set by cloud connector. CloudConfigCksum *string `json:"cloud_config_cksum,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // Connnection pool properties. Field introduced in 18.2.1. ConnPoolProperties *ConnPoolProperties `json:"conn_pool_properties,omitempty"` // Duration for which new connections will be gradually ramped up to a server recently brought online. Useful for LB algorithms that are least connection based. Allowed values are 1-300. Special values are 0 - 'Immediate'. Unit is MIN. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Special default for Basic edition is 0, Essentials edition is 0, Enterprise is 10. ConnectionRampDuration *int32 `json:"connection_ramp_duration,omitempty"` // Creator name. CreatedBy *string `json:"created_by,omitempty"` // Traffic sent to servers will use this destination server port unless overridden by the server's specific port attribute. The SSL checkbox enables Avi to server encryption. Allowed values are 1-65535. DefaultServerPort *int32 `json:"default_server_port,omitempty"` // Indicates whether existing IPs are disabled(false) or deleted(true) on dns hostname refreshDetail -- On a dns refresh, some IPs set on pool may no longer be returned by the resolver. These IPs are deleted from the pool when this knob is set to true. They are disabled, if the knob is set to false. Field introduced in 18.2.3. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. DeleteServerOnDNSRefresh *bool `json:"delete_server_on_dns_refresh,omitempty"` // A description of the pool. Description *string `json:"description,omitempty"` // Comma separated list of domain names which will be used to verify the common names or subject alternative names presented by server certificates. It is performed only when common name check host_check_enabled is enabled. DomainName []string `json:"domain_name,omitempty"` // Inherited config from VirtualService. EastWest *bool `json:"east_west,omitempty"` // Enable HTTP/2 for traffic from VirtualService to all backend servers in this pool. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableHttp2 *bool `json:"enable_http2,omitempty"` // Enable or disable the pool. Disabling will terminate all open connections and pause health monitors. Enabled *bool `json:"enabled,omitempty"` // Names of external auto-scale groups for pool servers. Currently available only for AWS and Azure. Field introduced in 17.1.2. ExternalAutoscaleGroups []string `json:"external_autoscale_groups,omitempty"` // Enable an action - Close Connection, HTTP Redirect or Local HTTP Response - when a pool failure happens. By default, a connection will be closed, in case the pool experiences a failure. FailAction *FailAction `json:"fail_action,omitempty"` // Periodicity of feedback for fewest tasks server selection algorithm. Allowed values are 1-300. Unit is SEC. FewestTasksFeedbackDelay *int32 `json:"fewest_tasks_feedback_delay,omitempty"` // Used to gracefully disable a server. Virtual service waits for the specified time before terminating the existing connections to the servers that are disabled. Allowed values are 1-7200. Special values are 0 - 'Immediate', -1 - 'Infinite'. Unit is MIN. GracefulDisableTimeout *int32 `json:"graceful_disable_timeout,omitempty"` // Indicates if the pool is a site-persistence pool. . Field introduced in 17.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. // Read Only: true GslbSpEnabled *bool `json:"gslb_sp_enabled,omitempty"` // Verify server health by applying one or more health monitors. Active monitors generate synthetic traffic from each Service Engine and mark a server up or down based on the response. The Passive monitor listens only to client to server communication. It raises or lowers the ratio of traffic destined to a server based on successful responses. It is a reference to an object of type HealthMonitor. Maximum of 50 items allowed. HealthMonitorRefs []string `json:"health_monitor_refs,omitempty"` // Enable common name check for server certificate. If enabled and no explicit domain name is specified, Avi will use the incoming host header to do the match. HostCheckEnabled *bool `json:"host_check_enabled,omitempty"` // Ignore the server port in building the load balancing state.Applicable only for consistent hash load balancing algorithm or Disable Port translation (use_service_port) use cases. Field introduced in 20.1.1. IgnoreServerPort *bool `json:"ignore_server_port,omitempty"` // The Passive monitor will monitor client to server connections and requests and adjust traffic load to servers based on successful responses. This may alter the expected behavior of the LB method, such as Round Robin. InlineHealthMonitor *bool `json:"inline_health_monitor,omitempty"` // Use list of servers from Ip Address Group. It is a reference to an object of type IpAddrGroup. IpaddrgroupRef *string `json:"ipaddrgroup_ref,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // The load balancing algorithm will pick a server within the pool's list of available servers. Values LB_ALGORITHM_NEAREST_SERVER and LB_ALGORITHM_TOPOLOGY are only allowed for GSLB pool. Enum options - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Allowed in Basic(Allowed values- LB_ALGORITHM_LEAST_CONNECTIONS,LB_ALGORITHM_ROUND_ROBIN,LB_ALGORITHM_CONSISTENT_HASH) edition, Essentials(Allowed values- LB_ALGORITHM_LEAST_CONNECTIONS,LB_ALGORITHM_ROUND_ROBIN,LB_ALGORITHM_CONSISTENT_HASH) edition, Enterprise edition. LbAlgorithm *string `json:"lb_algorithm,omitempty"` // HTTP header name to be used for the hash key. LbAlgorithmConsistentHashHdr *string `json:"lb_algorithm_consistent_hash_hdr,omitempty"` // Degree of non-affinity for core affinity based server selection. Allowed values are 1-65535. Field introduced in 17.1.3. Allowed in Basic(Allowed values- 2) edition, Essentials(Allowed values- 2) edition, Enterprise edition. LbAlgorithmCoreNonaffinity *int32 `json:"lb_algorithm_core_nonaffinity,omitempty"` // Criteria used as a key for determining the hash between the client and server. Enum options - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Allowed in Basic(Allowed values- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS) edition, Essentials(Allowed values- LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS) edition, Enterprise edition. LbAlgorithmHash *string `json:"lb_algorithm_hash,omitempty"` // Allow server lookup by name. Field introduced in 17.1.11,17.2.4. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. LookupServerByName *bool `json:"lookup_server_by_name,omitempty"` // The maximum number of concurrent connections allowed to each server within the pool. NOTE applied value will be no less than the number of service engines that the pool is placed on. If set to 0, no limit is applied. MaxConcurrentConnectionsPerServer *int32 `json:"max_concurrent_connections_per_server,omitempty"` // Rate Limit connections to each server. MaxConnRatePerServer *RateProfile `json:"max_conn_rate_per_server,omitempty"` // Minimum number of health monitors in UP state to mark server UP. Field introduced in 18.2.1, 17.2.12. Allowed in Basic edition, Essentials edition, Enterprise edition. MinHealthMonitorsUp *int32 `json:"min_health_monitors_up,omitempty"` // Minimum number of servers in UP state for marking the pool UP. Field introduced in 18.2.1, 17.2.12. MinServersUp *int32 `json:"min_servers_up,omitempty"` // The name of the pool. // Required: true Name *string `json:"name"` // (internal-use) Networks designated as containing servers for this pool. The servers may be further narrowed down by a filter. This field is used internally by Avi, not editable by the user. Networks []*NetworkFilter `json:"networks,omitempty"` // A list of NSX Groups where the Servers for the Pool are created . Field introduced in 17.1.1. NsxSecuritygroup []string `json:"nsx_securitygroup,omitempty"` // Avi will validate the SSL certificate present by a server against the selected PKI Profile. It is a reference to an object of type PKIProfile. PkiProfileRef *string `json:"pki_profile_ref,omitempty"` // Manually select the networks and subnets used to provide reachability to the pool's servers. Specify the Subnet using the following syntax 10-1-1-0/24. Use static routes in VRF configuration when pool servers are not directly connected but routable from the service engine. PlacementNetworks []*PlacementNetwork `json:"placement_networks,omitempty"` // Header name for custom header persistence. Field deprecated in 18.1.2. PrstHdrName *string `json:"prst_hdr_name,omitempty"` // Minimum number of requests to be queued when pool is full. Allowed in Basic(Allowed values- 128) edition, Essentials(Allowed values- 128) edition, Enterprise edition. RequestQueueDepth *int32 `json:"request_queue_depth,omitempty"` // Enable request queue when pool is full. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. RequestQueueEnabled *bool `json:"request_queue_enabled,omitempty"` // This field is used as a flag to create a job for JobManager. Field introduced in 18.2.10,20.1.2. ResolvePoolByDNS *bool `json:"resolve_pool_by_dns,omitempty"` // Rewrite incoming Host Header to server name of the server to which the request is proxied. Enabling this feature rewrites Host Header for requests to all servers in the pool. RewriteHostHeaderToServerName *bool `json:"rewrite_host_header_to_server_name,omitempty"` // If SNI server name is specified, rewrite incoming host header to the SNI server name. RewriteHostHeaderToSni *bool `json:"rewrite_host_header_to_sni,omitempty"` // Enable to do routing when this pool is selected to send traffic. No servers present in routing pool. Field introduced in 20.1.1. RoutingPool *bool `json:"routing_pool,omitempty"` // Server AutoScale. Not used anymore. Field deprecated in 18.1.2. ServerAutoScale *bool `json:"server_auto_scale,omitempty"` // Field deprecated in 18.2.1. ServerCount *int32 `json:"server_count,omitempty"` // Fully qualified DNS hostname which will be used in the TLS SNI extension in server connections if SNI is enabled. If no value is specified, Avi will use the incoming host header instead. ServerName *string `json:"server_name,omitempty"` // Server reselect configuration for HTTP requests. ServerReselect *HttpserverReselect `json:"server_reselect,omitempty"` // Server timeout value specifies the time within which a server connection needs to be established and a request-response exchange completes between AVI and the server. Value of 0 results in using default timeout of 60 minutes. Allowed values are 0-3600000. Field introduced in 18.1.5,18.2.1. Unit is MILLISECONDS. ServerTimeout *int32 `json:"server_timeout,omitempty"` // The pool directs load balanced traffic to this list of destination servers. The servers can be configured by IP address, name, network or via IP Address Group. Maximum of 5000 items allowed. Servers []*Server `json:"servers,omitempty"` // Metadata pertaining to the service provided by this Pool. In Openshift/Kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by Avi Vantage. Field introduced in 17.2.14,18.1.5,18.2.1. ServiceMetadata *string `json:"service_metadata,omitempty"` // Enable TLS SNI for server connections. If disabled, Avi will not send the SNI extension as part of the handshake. SniEnabled *bool `json:"sni_enabled,omitempty"` // Service Engines will present a client SSL certificate to the server. It is a reference to an object of type SSLKeyAndCertificate. SslKeyAndCertificateRef *string `json:"ssl_key_and_certificate_ref,omitempty"` // When enabled, Avi re-encrypts traffic to the backend servers. The specific SSL profile defines which ciphers and SSL versions will be supported. It is a reference to an object of type SSLProfile. SslProfileRef *string `json:"ssl_profile_ref,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // This tier1_lr field should be set same as VirtualService associated for NSX-T. Field introduced in 20.1.1. Tier1Lr *string `json:"tier1_lr,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Do not translate the client's destination port when sending the connection to the server. The pool or servers specified service port will still be used for health monitoring. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. UseServicePort *bool `json:"use_service_port,omitempty"` // UUID of the pool. UUID *string `json:"uuid,omitempty"` // Virtual Routing Context that the pool is bound to. This is used to provide the isolation of the set of networks the pool is attached to. The pool inherits the Virtual Routing Conext of the Virtual Service, and this field is used only internally, and is set by pb-transform. It is a reference to an object of type VrfContext. VrfRef *string `json:"vrf_ref,omitempty"` }
Pool pool swagger:model Pool
type PoolAPIResponse ¶
type PoolAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Pool `json:"results,omitempty"` }
PoolAPIResponse pool Api response swagger:model PoolApiResponse
type PoolAnalyticsPolicy ¶
type PoolAnalyticsPolicy struct { // Enable real time metrics for server and pool metrics eg. l4_server.xxx, l7_server.xxx. Field introduced in 18.1.5, 18.2.1. EnableRealtimeMetrics *bool `json:"enable_realtime_metrics,omitempty"` }
PoolAnalyticsPolicy pool analytics policy swagger:model PoolAnalyticsPolicy
type PoolDeploymentFailureInfo ¶
type PoolDeploymentFailureInfo struct { // Curent in-service pool. It is a reference to an object of type Pool. CurrInServicePoolName *string `json:"curr_in_service_pool_name,omitempty"` // Curent in service pool. It is a reference to an object of type Pool. CurrInServicePoolRef *string `json:"curr_in_service_pool_ref,omitempty"` // Operational traffic ratio for the pool. Ratio *int32 `json:"ratio,omitempty"` // Placeholder for description of property results of obj type PoolDeploymentFailureInfo field type str type object Results []*PGDeploymentRuleResult `json:"results,omitempty"` // Pool's ID. UUID *string `json:"uuid,omitempty"` // Reason returned in webhook callback when configured. WebhookReason *string `json:"webhook_reason,omitempty"` // Result of webhook callback when configured. WebhookResult *bool `json:"webhook_result,omitempty"` }
PoolDeploymentFailureInfo pool deployment failure info swagger:model PoolDeploymentFailureInfo
type PoolDeploymentSuccessInfo ¶
type PoolDeploymentSuccessInfo struct { // Previous pool in service. Field introduced in 18.1.1. PrevInServicePoolName *string `json:"prev_in_service_pool_name,omitempty"` // Previous pool in service. It is a reference to an object of type Pool. PrevInServicePoolRef *string `json:"prev_in_service_pool_ref,omitempty"` // Operational traffic ratio for the pool. Ratio *int32 `json:"ratio,omitempty"` // List of results for each deployment rule. Results []*PGDeploymentRuleResult `json:"results,omitempty"` // Pool's ID. UUID *string `json:"uuid,omitempty"` // Reason returned in webhook callback when configured. WebhookReason *string `json:"webhook_reason,omitempty"` // Result of webhook callback when configured. WebhookResult *bool `json:"webhook_result,omitempty"` }
PoolDeploymentSuccessInfo pool deployment success info swagger:model PoolDeploymentSuccessInfo
type PoolDeploymentUpdateInfo ¶
type PoolDeploymentUpdateInfo struct { // Pool deployment state used with the PG deployment policy. Enum options - EVALUATION_IN_PROGRESS, IN_SERVICE, OUT_OF_SERVICE, EVALUATION_FAILED. DeploymentState *string `json:"deployment_state,omitempty"` // Evaluation period for deployment update. Unit is SEC. EvaluationDuration *int32 `json:"evaluation_duration,omitempty"` // Operational traffic ratio for the pool. Ratio *int32 `json:"ratio,omitempty"` // List of results for each deployment rule. Results []*PGDeploymentRuleResult `json:"results,omitempty"` // Member Pool's ID. UUID *string `json:"uuid,omitempty"` // Reason returned in webhook callback when configured. WebhookReason *string `json:"webhook_reason,omitempty"` // Result of webhook callback when configured. WebhookResult *bool `json:"webhook_result,omitempty"` }
PoolDeploymentUpdateInfo pool deployment update info swagger:model PoolDeploymentUpdateInfo
type PoolGroup ¶
type PoolGroup struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Checksum of cloud configuration for PoolGroup. Internally set by cloud connector. CloudConfigCksum *string `json:"cloud_config_cksum,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // Name of the user who created the object. CreatedBy *string `json:"created_by,omitempty"` // When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type PoolGroupDeploymentPolicy. DeploymentPolicyRef *string `json:"deployment_policy_ref,omitempty"` // Description of Pool Group. Description *string `json:"description,omitempty"` // Enable HTTP/2 for traffic from VirtualService to all the backend servers in all the pools configured under this PoolGroup. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableHttp2 *bool `json:"enable_http2,omitempty"` // Enable an action - Close Connection, HTTP Redirect, or Local HTTP Response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. FailAction *FailAction `json:"fail_action,omitempty"` // Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. ImplicitPriorityLabels *bool `json:"implicit_priority_labels,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // List of pool group members object of type PoolGroupMember. Members []*PoolGroupMember `json:"members,omitempty"` // The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - 'Disable'. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. MinServers *int32 `json:"min_servers,omitempty"` // The name of the pool group. // Required: true Name *string `json:"name"` // UUID of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type PriorityLabels. PriorityLabelsRef *string `json:"priority_labels_ref,omitempty"` // Metadata pertaining to the service provided by this PoolGroup. In Openshift/Kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by Avi Vantage. Field introduced in 17.2.14,18.1.5,18.2.1. ServiceMetadata *string `json:"service_metadata,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the pool group. UUID *string `json:"uuid,omitempty"` }
PoolGroup pool group swagger:model PoolGroup
type PoolGroupAPIResponse ¶
type PoolGroupAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*PoolGroup `json:"results,omitempty"` }
PoolGroupAPIResponse pool group Api response swagger:model PoolGroupApiResponse
type PoolGroupDeploymentPolicy ¶
type PoolGroupDeploymentPolicy struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // It will automatically disable old production pools once there is a new production candidate. AutoDisableOldProdPools *bool `json:"auto_disable_old_prod_pools,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is SEC. EvaluationDuration *int32 `json:"evaluation_duration,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // The name of the pool group deployment policy. // Required: true Name *string `json:"name"` // Placeholder for description of property rules of obj type PoolGroupDeploymentPolicy field type str type object Rules []*PGDeploymentRule `json:"rules,omitempty"` // deployment scheme. Enum options - BLUE_GREEN, CANARY. Scheme *string `json:"scheme,omitempty"` // Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is RATIO. TargetTestTrafficRatio *int32 `json:"target_test_traffic_ratio,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Ratio of the traffic that is sent to the pool under test. test ratio of 100 means blue green. Allowed values are 1-100. TestTrafficRatioRampup *int32 `json:"test_traffic_ratio_rampup,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the pool group deployment policy. UUID *string `json:"uuid,omitempty"` // Webhook configured with URL that Avi controller will pass back information about pool group, old and new pool information and current deployment rule results. It is a reference to an object of type Webhook. Field introduced in 17.1.1. WebhookRef *string `json:"webhook_ref,omitempty"` }
PoolGroupDeploymentPolicy pool group deployment policy swagger:model PoolGroupDeploymentPolicy
type PoolGroupDeploymentPolicyAPIResponse ¶
type PoolGroupDeploymentPolicyAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*PoolGroupDeploymentPolicy `json:"results,omitempty"` }
PoolGroupDeploymentPolicyAPIResponse pool group deployment policy Api response swagger:model PoolGroupDeploymentPolicyApiResponse
type PoolGroupMember ¶
type PoolGroupMember struct { // Pool deployment state used with the PG deployment policy. Enum options - EVALUATION_IN_PROGRESS, IN_SERVICE, OUT_OF_SERVICE, EVALUATION_FAILED. DeploymentState *string `json:"deployment_state,omitempty"` // UUID of the pool. It is a reference to an object of type Pool. // Required: true PoolRef *string `json:"pool_ref"` // All pools with same label are treated similarly in a pool group. A pool with a higher priority is selected, as long as the pool is eligible or an explicit policy chooses a different pool. PriorityLabel *string `json:"priority_label,omitempty"` // Ratio of selecting eligible pools in the pool group. . Allowed values are 1-1000. Special values are 0 - 'Do not select this pool for new connections'. Allowed in Basic(Allowed values- 1) edition, Essentials(Allowed values- 1) edition, Enterprise edition. Ratio *int32 `json:"ratio,omitempty"` }
PoolGroupMember pool group member swagger:model PoolGroupMember
type PoolServer ¶
type PoolServer struct { // DNS resolvable name of the server. May be used in place of the IP address. Hostname *string `json:"hostname,omitempty"` // IP address of the server in the poool. // Required: true IP *IPAddr `json:"ip"` // Port of the pool server listening for HTTP/HTTPS. Default value is the default port in the pool. Allowed values are 1-65535. Port *int32 `json:"port,omitempty"` }
PoolServer pool server swagger:model PoolServer
type PortMatch ¶
type PortMatch struct { // Criterion to use for port matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. // Required: true MatchCriteria *string `json:"match_criteria"` // Listening TCP port(s). Allowed values are 1-65535. Minimum of 1 items required. Ports []int64 `json:"ports,omitempty,omitempty"` }
PortMatch port match swagger:model PortMatch
type PortMatchGeneric ¶
type PortMatchGeneric struct { // Criterion to use for src/dest port in a TCP/UDP packet. Enum options - IS_IN, IS_NOT_IN. Field introduced in 20.1.3. // Required: true MatchCriteria *string `json:"match_criteria"` // Listening TCP port(s). Allowed values are 1-65535. Field introduced in 20.1.3. Ports []int64 `json:"ports,omitempty,omitempty"` // A port range defined by a start and end, including both. Field introduced in 20.1.3. Ranges []*PortRange `json:"ranges,omitempty"` }
PortMatchGeneric port match generic swagger:model PortMatchGeneric
type PortRange ¶
type PortRange struct { // TCP/UDP port range end (inclusive). Allowed values are 1-65535. // Required: true End *int32 `json:"end"` // TCP/UDP port range start (inclusive). Allowed values are 1-65535. // Required: true Start *int32 `json:"start"` }
PortRange port range swagger:model PortRange
type PortalConfiguration ¶
type PortalConfiguration struct { // Enable/Disable HTTP basic authentication. AllowBasicAuthentication *bool `json:"allow_basic_authentication,omitempty"` // Force API session timeout after the specified time (in hours). Allowed values are 1-24. Field introduced in 18.2.3. Unit is HOURS. APIForceTimeout *int32 `json:"api_force_timeout,omitempty"` // Disable Remote CLI Shell Client access. DisableRemoteCliShell *bool `json:"disable_remote_cli_shell,omitempty"` // Disable Swagger access. Field introduced in 18.2.3. DisableSwagger *bool `json:"disable_swagger,omitempty"` // Enable/Disable Clickjacking protection. EnableClickjackingProtection *bool `json:"enable_clickjacking_protection,omitempty"` // Placeholder for description of property enable_http of obj type PortalConfiguration field type str type boolean EnableHTTP *bool `json:"enable_http,omitempty"` // Placeholder for description of property enable_https of obj type PortalConfiguration field type str type boolean EnableHTTPS *bool `json:"enable_https,omitempty"` // HTTP port. HTTPPort *int32 `json:"http_port,omitempty"` // HTTPS port. HTTPSPort *int32 `json:"https_port,omitempty"` // Minimum password length for user accounts. Allowed values are 6-32. Field introduced in 20.1.3. MinimumPasswordLength *int32 `json:"minimum_password_length,omitempty"` // Strict checking of password strength for user accounts. PasswordStrengthCheck *bool `json:"password_strength_check,omitempty"` // Placeholder for description of property redirect_to_https of obj type PortalConfiguration field type str type boolean RedirectToHTTPS *bool `json:"redirect_to_https,omitempty"` // Certificates for system portal. Maximum 2 allowed. Leave list empty to use system default certs. It is a reference to an object of type SSLKeyAndCertificate. Maximum of 2 items allowed. SslkeyandcertificateRefs []string `json:"sslkeyandcertificate_refs,omitempty"` // It is a reference to an object of type SSLProfile. SslprofileRef *string `json:"sslprofile_ref,omitempty"` // Use UUID in POST object data as UUID of the new object, instead of a generated UUID. UseUUIDFromInput *bool `json:"use_uuid_from_input,omitempty"` }
PortalConfiguration portal configuration swagger:model PortalConfiguration
type PortalFeatureOptIn ¶
type PortalFeatureOptIn struct { // Enable to subscribe to automated Application Signature Rulesets updates. Field introduced in 20.1.4. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableAppsignatureSync *bool `json:"enable_appsignature_sync,omitempty"` // Enable pro-active support case creation when a service engine failure occurs. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableAutoCaseCreationOnSeFailure *bool `json:"enable_auto_case_creation_on_se_failure,omitempty"` // Enable pro-active support case creation when a system failure occurs. Manual download will still be available in the customer portal. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableAutoCaseCreationOnSystemFailure *bool `json:"enable_auto_case_creation_on_system_failure,omitempty"` // Enable to automatically download new CRS version to the Controller. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableAutoDownloadWafSignatures *bool `json:"enable_auto_download_waf_signatures,omitempty"` // Enable to subscribe to IP reputation updates. This is a requirement for using IP reputation in the product. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableIPReputation *bool `json:"enable_ip_reputation,omitempty"` // Enable event notifications when new CRS versions are available. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. EnableWafSignaturesNotifications *bool `json:"enable_waf_signatures_notifications,omitempty"` }
PortalFeatureOptIn portal feature opt in swagger:model PortalFeatureOptIn
type PriorityLabels ¶
type PriorityLabels struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // A description of the priority labels. Description *string `json:"description,omitempty"` // Equivalent priority labels in descending order. EquivalentLabels []*EquivalentLabels `json:"equivalent_labels,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // The name of the priority labels. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the priority labels. UUID *string `json:"uuid,omitempty"` }
PriorityLabels priority labels swagger:model PriorityLabels
type PriorityLabelsAPIResponse ¶
type PriorityLabelsAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*PriorityLabels `json:"results,omitempty"` }
PriorityLabelsAPIResponse priority labels Api response swagger:model PriorityLabelsApiResponse
type ProactiveSupportDefaults ¶
type ProactiveSupportDefaults struct { // Opt-in to attach core dump with support case. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AttachCoreDump *bool `json:"attach_core_dump,omitempty"` // Opt-in to attach tech support with support case. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. AttachTechSupport *bool `json:"attach_tech_support,omitempty"` // Case severity to be used for proactive support case creation. Field introduced in 20.1.1. CaseSeverity *string `json:"case_severity,omitempty"` }
ProactiveSupportDefaults proactive support defaults swagger:model ProactiveSupportDefaults
type Property ¶
type Property struct { // Property name. Field introduced in 17.2.1. // Required: true Name *string `json:"name"` // Property value. Field introduced in 17.2.1. Value *string `json:"value,omitempty"` }
Property property swagger:model Property
type ProtocolMatch ¶
type ProtocolMatch struct { // Criterion to use for protocol matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. // Required: true MatchCriteria *string `json:"match_criteria"` // HTTP or HTTPS protocol. Enum options - HTTP, HTTPS. // Required: true Protocols *string `json:"protocols"` }
ProtocolMatch protocol match swagger:model ProtocolMatch
type ProtocolParser ¶
type ProtocolParser struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Description of the protocol parser. Field introduced in 18.2.3. Description *string `json:"description,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the protocol parser. Field introduced in 18.2.3. // Required: true Name *string `json:"name"` // Command script provided inline. Field introduced in 18.2.3. // Required: true ParserCode *string `json:"parser_code"` // Tenant UUID of the protocol parser. It is a reference to an object of type Tenant. Field introduced in 18.2.3. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the protocol parser. Field introduced in 18.2.3. UUID *string `json:"uuid,omitempty"` }
ProtocolParser protocol parser swagger:model ProtocolParser
type ProtocolParserAPIResponse ¶
type ProtocolParserAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ProtocolParser `json:"results,omitempty"` }
ProtocolParserAPIResponse protocol parser Api response swagger:model ProtocolParserApiResponse
type ProxyConfiguration ¶
type ProxyConfiguration struct { // Proxy hostname or IP address. // Required: true Host *string `json:"host"` // Password for proxy. Password *string `json:"password,omitempty"` // Proxy port. // Required: true Port *int32 `json:"port"` // Username for proxy. Username *string `json:"username,omitempty"` }
ProxyConfiguration proxy configuration swagger:model ProxyConfiguration
type PsmProgramDetails ¶
type PsmProgramDetails struct { // error of PsmProgramDetails. Error *string `json:"error,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` }
PsmProgramDetails psm program details swagger:model PsmProgramDetails
type QueryMatch ¶
type QueryMatch struct { // Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. MatchCase *string `json:"match_case,omitempty"` // Criterion to use for matching the query in HTTP request URI. Enum options - QUERY_MATCH_CONTAINS. // Required: true MatchCriteria *string `json:"match_criteria"` // String value(s). MatchStr []string `json:"match_str,omitempty"` // UUID of the *string group(s). It is a reference to an object of type StringGroup. StringGroupRefs []string `json:"string_group_refs,omitempty"` }
QueryMatch query match swagger:model QueryMatch
type RancherConfiguration ¶
type RancherConfiguration struct { // Access key. AccessKey *string `json:"access_key,omitempty"` // Sync frequency in seconds with frameworks. AppSyncFrequency *int32 `json:"app_sync_frequency,omitempty"` // Perform container port matching to create a HTTP Virtualservice instead of a TCP/UDP VirtualService. ContainerPortMatchHTTPService *bool `json:"container_port_match_http_service,omitempty"` // Directory to mount to check for core dumps on Service Engines. This will be mapped read only to /var/crash on any new Service Engines. This is a disruptive change. CoredumpDirectory *string `json:"coredump_directory,omitempty"` // Disable auto service sync for back end services. DisableAutoBackendServiceSync *bool `json:"disable_auto_backend_service_sync,omitempty"` // Disable auto service sync for front end services. DisableAutoFrontendServiceSync *bool `json:"disable_auto_frontend_service_sync,omitempty"` // Disable SE creation. DisableAutoSeCreation *bool `json:"disable_auto_se_creation,omitempty"` // Docker registry for ServiceEngine image. DockerRegistrySe *DockerRegistry `json:"docker_registry_se,omitempty"` // Match against this prefix when placing east-west VSs on SEs . EastWestPlacementSubnet *IPAddrPrefix `json:"east_west_placement_subnet,omitempty"` // Enable Docker event subscription. EnableEventSubscription *bool `json:"enable_event_subscription,omitempty"` // For Front End proxies, use container port as service port. FeproxyContainerPortAsService *bool `json:"feproxy_container_port_as_service,omitempty"` // Enable proxy ARP from Host interface for Front End proxies. FeproxyVipsEnableProxyArp *bool `json:"feproxy_vips_enable_proxy_arp,omitempty"` // Optional fleet remote endpoint if fleet is used for SE deployment. FleetEndpoint *string `json:"fleet_endpoint,omitempty"` // List of container ports that create a HTTP Virtualservice instead of a TCP/UDP VirtualService. Defaults to 80. HTTPContainerPorts []int64 `json:"http_container_ports,omitempty,omitempty"` // Nuage Overlay SDN Controller information. NuageController *NuageSDNController `json:"nuage_controller,omitempty"` // List of Rancher servers; In case of a load balanced Rancher multi cluster, use Virtual IP of the cluster. RancherServers []string `json:"rancher_servers,omitempty"` // Use Fleet/SSH for SE deployment. Enum options - SE_CREATE_FLEET, SE_CREATE_SSH, SE_CREATE_POD. SeDeploymentMethod *string `json:"se_deployment_method,omitempty"` // Exclude hosts with attributes for SE creation. SeExcludeAttributes []*MesosAttribute `json:"se_exclude_attributes,omitempty"` // Create SEs just on hosts with include attributes. SeIncludeAttributes []*MesosAttribute `json:"se_include_attributes,omitempty"` // New SE spawn rate per minute. SeSpawnRate *int32 `json:"se_spawn_rate,omitempty"` // Host volume to be used as a disk for Avi SE, This is a disruptive change. SeVolume *string `json:"se_volume,omitempty"` // Secret key. SecretKey *string `json:"secret_key,omitempty"` // Make service ports accessible on all Host interfaces in addition to East-West VIP and/or bridge IP. Usually enabled AWS clusters to export East-West services on Host interface. ServicesAccessibleAllInterfaces *bool `json:"services_accessible_all_interfaces,omitempty"` // Parameters for SSH SE deployment. Field deprecated in 17.1.1. SSHSeDeployment *SSHSeDeployment `json:"ssh_se_deployment,omitempty"` // Cloud connector user uuid for SSH to hosts. It is a reference to an object of type CloudConnectorUser. Field introduced in 17.1.1. SSHUserRef *string `json:"ssh_user_ref,omitempty"` // Use container IP address port for pool instead of host IP address hostport. This mode is applicable if the container IP is reachable (not a private NATed IP) from other hosts in a routed environment for containers. UseContainerIPPort *bool `json:"use_container_ip_port,omitempty"` // If true, use controller generated SE docker image via fileservice, else use docker repository image as defined by docker_registry_se. UseControllerImage *bool `json:"use_controller_image,omitempty"` }
RancherConfiguration rancher configuration swagger:model RancherConfiguration
type RateLimiter ¶
type RateLimiter struct { // Maximum number of connections, requests or packets to be let through instantaneously. If this is less than count, it will have no effect. Allowed values are 0-1000000000. Field introduced in 18.2.9. BurstSz *int32 `json:"burst_sz,omitempty"` // Maximum number of connections, requests or packets permitted each period. Allowed values are 1-1000000000. Field introduced in 18.2.9. // Required: true Count *int32 `json:"count"` // Identifier for Rate Limit. Constructed according to context. Field introduced in 18.2.9. Name *string `json:"name,omitempty"` // Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Field introduced in 18.2.9. Unit is SEC. // Required: true Period *int32 `json:"period"` }
RateLimiter rate limiter swagger:model RateLimiter
type RateLimiterAction ¶
type RateLimiterAction struct { // File to be used for HTTP Local response rate limit action. File *HTTPLocalFile `json:"file,omitempty"` // Parameters for HTTP Redirect rate limit action. Redirect *HTTPRedirectAction `json:"redirect,omitempty"` // HTTP status code for Local Response rate limit action. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501. StatusCode *string `json:"status_code,omitempty"` // Type of action to be enforced upon hitting the rate limit. Enum options - RL_ACTION_NONE, RL_ACTION_DROP_CONN, RL_ACTION_RESET_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_REDIRECT. Type *string `json:"type,omitempty"` }
RateLimiterAction rate limiter action swagger:model RateLimiterAction
type RateLimiterEventDetails ¶
type RateLimiterEventDetails struct { // Rate limiter error message. Field introduced in 20.1.1. ErrorMessage *string `json:"error_message,omitempty"` // Name of the rate limiter. Field introduced in 20.1.1. RlResourceName *string `json:"rl_resource_name,omitempty"` // Rate limiter type. Field introduced in 20.1.1. RlResourceType *string `json:"rl_resource_type,omitempty"` // Status. Field introduced in 20.1.1. Status *string `json:"status,omitempty"` }
RateLimiterEventDetails rate limiter event details swagger:model RateLimiterEventDetails
type RateLimiterProfile ¶
type RateLimiterProfile struct { // Rate Limit all connections made from any single client IP address to the Virtual Service. ClientIPConnectionsRateLimit *RateProfile `json:"client_ip_connections_rate_limit,omitempty"` // Rate Limit all requests from a client for a specified period of time once the count of failed requests from that client crosses a threshold for that period. Clients are tracked based on their IP address. Count and time period are specified through the RateProfile. Requests are deemed failed based on client or server side error status codes, consistent with how Avi Logs and Metrics subsystems mark failed requests. . ClientIPFailedRequestsRateLimit *RateProfile `json:"client_ip_failed_requests_rate_limit,omitempty"` // Rate Limit all HTTP requests from any single client IP address to all URLs of the Virtual Service. ClientIPRequestsRateLimit *RateProfile `json:"client_ip_requests_rate_limit,omitempty"` // Automatically track clients and classify them into 3 groups - Good, Bad, Unknown. Clients are tracked based on their IP Address. Clients are added to the Good group when the Avi Scan Detection system builds history of requests from them that complete successfully. Clients are added to Unknown group when there is insufficient history about them. Requests from such clients are rate limited to the rate specified in the RateProfile. Finally, Clients with history of failed requests are added to Bad group and their requests are rate limited with stricter thresholds than the Unknown Clients group. The Avi Scan Detection system automatically tunes itself so that the Good, Bad, and Unknown client IPs group membership changes dynamically with the changes in traffic patterns through the ADC. ClientIPScannersRequestsRateLimit *RateProfile `json:"client_ip_scanners_requests_rate_limit,omitempty"` // Rate Limit all requests from a client to a URI for a specified period of time once the count of failed requests from that client to the URI crosses a threshold for that period. Clients are tracked based on their IP address. Count and time period are specified through the RateProfile. Requests are deemed failed based on client or server side error status codes, consistent with how Avi Logs and Metrics subsystems mark failed requests. . ClientIPToURIFailedRequestsRateLimit *RateProfile `json:"client_ip_to_uri_failed_requests_rate_limit,omitempty"` // Rate Limit all HTTP requests from any single client IP address to any single URL. ClientIPToURIRequestsRateLimit *RateProfile `json:"client_ip_to_uri_requests_rate_limit,omitempty"` // Rate Limit all HTTP requests that map to any custom string. Field introduced in 17.2.13,18.1.3,18.2.1. CustomRequestsRateLimit *RateProfile `json:"custom_requests_rate_limit,omitempty"` // Rate Limit all HTTP requests from all client IP addresses that contain any single HTTP header value. Field introduced in 17.1.1. HTTPHeaderRateLimits []*RateProfile `json:"http_header_rate_limits,omitempty"` // Rate Limit all requests to a URI for a specified period of time once the count of failed requests to that URI crosses a threshold for that period. Count and time period are specified through the RateProfile. Requests are deemed failed based on client or server side error status codes, consistent with how Avi Logs and Metrics subsystems mark failed requests. . URIFailedRequestsRateLimit *RateProfile `json:"uri_failed_requests_rate_limit,omitempty"` // Rate Limit all HTTP requests from all client IP addresses to any single URL. URIRequestsRateLimit *RateProfile `json:"uri_requests_rate_limit,omitempty"` // Automatically track URIs and classify them into 3 groups - Good, Bad, Unknown. URIs are added to the Good group when the Avi Scan Detection system builds history of requests to URIs that complete successfully. URIs are added to Unknown group when there is insufficient history about them. Requests for such URIs are rate limited to the rate specified in the RateProfile. Finally, URIs with history of failed requests are added to Bad group and requests to them are rate limited with stricter thresholds than the Unknown URIs group. The Avi Scan Detection system automatically tunes itself so that the Good, Bad, and Unknown URIs group membership changes dynamically with the changes in traffic patterns through the ADC. URIScannersRequestsRateLimit *RateProfile `json:"uri_scanners_requests_rate_limit,omitempty"` }
RateLimiterProfile rate limiter profile swagger:model RateLimiterProfile
type RateLimiterProperties ¶
type RateLimiterProperties struct { // Number of stages in msf rate limiter. Allowed values are 1-2. Field introduced in 20.1.1. MsfNumStages *int32 `json:"msf_num_stages,omitempty"` // Each stage size in msf rate limiter. Field introduced in 20.1.1. MsfStageSize *int64 `json:"msf_stage_size,omitempty"` }
RateLimiterProperties rate limiter properties swagger:model RateLimiterProperties
type RateProfile ¶
type RateProfile struct { // Action to perform upon rate limiting. // Required: true Action *RateLimiterAction `json:"action"` // Maximum number of connections or requests or packets to be let through instantaneously. Allowed values are 10-2500. Special values are 0- 'automatic'. Field deprecated in 18.2.9. BurstSz *int32 `json:"burst_sz,omitempty"` // Maximum number of connections or requests or packets. Allowed values are 1-1000000000. Special values are 0- 'unlimited'. Field deprecated in 18.2.9. Count *int32 `json:"count,omitempty"` // Explicitly tracks an attacker across rate periods. ExplicitTracking *bool `json:"explicit_tracking,omitempty"` // Enable fine granularity. FineGrain *bool `json:"fine_grain,omitempty"` // HTTP cookie name. Field introduced in 17.1.1. HTTPCookie *string `json:"http_cookie,omitempty"` // HTTP header name. Field introduced in 17.1.1. HTTPHeader *string `json:"http_header,omitempty"` // Time value in seconds to enforce rate count. Allowed values are 1-300. Field deprecated in 18.2.9. Unit is SEC. Period *int32 `json:"period,omitempty"` // The rate limiter configuration for this rate profile. Field introduced in 18.2.9. RateLimiter *RateLimiter `json:"rate_limiter,omitempty"` }
RateProfile rate profile swagger:model RateProfile
type RebalanceMigrateEventDetails ¶
type RebalanceMigrateEventDetails struct { // Placeholder for description of property migrate_params of obj type RebalanceMigrateEventDetails field type str type object MigrateParams *VsMigrateParams `json:"migrate_params,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
RebalanceMigrateEventDetails rebalance migrate event details swagger:model RebalanceMigrateEventDetails
type RebalanceScaleinEventDetails ¶
type RebalanceScaleinEventDetails struct { // Placeholder for description of property scalein_params of obj type RebalanceScaleinEventDetails field type str type object ScaleinParams *VsScaleinParams `json:"scalein_params,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
RebalanceScaleinEventDetails rebalance scalein event details swagger:model RebalanceScaleinEventDetails
type RebalanceScaleoutEventDetails ¶
type RebalanceScaleoutEventDetails struct { // Placeholder for description of property scaleout_params of obj type RebalanceScaleoutEventDetails field type str type object ScaleoutParams *VsScaleoutParams `json:"scaleout_params,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
RebalanceScaleoutEventDetails rebalance scaleout event details swagger:model RebalanceScaleoutEventDetails
type RebootData ¶
type RebootData struct { // Patch version for which reboot flag need to be computed. Field introduced in 18.2.8, 20.1.1. PatchVersion *string `json:"patch_version,omitempty"` // This variable tells whether reboot has to be performed. Field introduced in 18.2.8, 20.1.1. Reboot *bool `json:"reboot,omitempty"` }
RebootData reboot data swagger:model RebootData
type RediscoverVcenterParam ¶
type RediscoverVcenterParam struct { // cloud of RediscoverVcenterParam. // Required: true Cloud *string `json:"cloud"` }
RediscoverVcenterParam rediscover vcenter param swagger:model RediscoverVcenterParam
type ReplaceStringVar ¶
type ReplaceStringVar struct { // Type of replacement *string - can be a variable exposed from datascript, value of an HTTP header or a custom user-input literal string. Enum options - DATASCRIPT_VAR, HTTP_HEADER_VAR, LITERAL_STRING. Type *string `json:"type,omitempty"` // Value of the replacement *string - name of variable exposed from datascript, name of the HTTP header or a custom user-input literal string. Val *string `json:"val,omitempty"` }
ReplaceStringVar replace *string var swagger:model ReplaceStringVar
type ReplicationPolicy ¶
type ReplicationPolicy struct { // Leader's checkpoint. Follower attempt to replicate configuration till this checkpoint. It is a reference to an object of type FederationCheckpoint. Field introduced in 20.1.1. CheckpointRef *string `json:"checkpoint_ref,omitempty"` // Replication mode. Enum options - REPLICATION_MODE_CONTINUOUS, REPLICATION_MODE_MANUAL, REPLICATION_MODE_ADAPTIVE. Field introduced in 20.1.1. ReplicationMode *string `json:"replication_mode,omitempty"` }
ReplicationPolicy replication policy swagger:model ReplicationPolicy
type ResponseMatchTarget ¶
type ResponseMatchTarget struct { // Configure client ip addresses. ClientIP *IPAddrMatch `json:"client_ip,omitempty"` // Configure HTTP cookie(s). Cookie *CookieMatch `json:"cookie,omitempty"` // Configure HTTP headers. Hdrs []*HdrMatch `json:"hdrs,omitempty"` // Configure the host header. HostHdr *HostHdrMatch `json:"host_hdr,omitempty"` // Configure the location header. LocHdr *LocationHdrMatch `json:"loc_hdr,omitempty"` // Configure HTTP methods. Method *MethodMatch `json:"method,omitempty"` // Configure request paths. Path *PathMatch `json:"path,omitempty"` // Configure the type of HTTP protocol. Protocol *ProtocolMatch `json:"protocol,omitempty"` // Configure request query. Query *QueryMatch `json:"query,omitempty"` // Configure the HTTP headers in response. RspHdrs []*HdrMatch `json:"rsp_hdrs,omitempty"` // Configure the HTTP status code(s). Status *HttpstatusMatch `json:"status,omitempty"` // Configure versions of the HTTP protocol. Version *HTTPVersionMatch `json:"version,omitempty"` // Configure virtual service ports. VsPort *PortMatch `json:"vs_port,omitempty"` }
ResponseMatchTarget response match target swagger:model ResponseMatchTarget
type RetryPlacementParams ¶
type RetryPlacementParams struct { // Retry placement operations for all East-West services. Field introduced in 17.1.6,17.2.2. AllEastWest *bool `json:"all_east_west,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Indicates the vip_id that needs placement retrial. Field introduced in 17.1.2. // Required: true VipID *string `json:"vip_id"` }
RetryPlacementParams retry placement params swagger:model RetryPlacementParams
type RmAddNetworksEventDetails ¶
type RmAddNetworksEventDetails struct { // Placeholder for description of property networks of obj type RmAddNetworksEventDetails field type str type object Networks []*RmAddVnic `json:"networks,omitempty"` // reason of RmAddNetworksEventDetails. Reason *string `json:"reason,omitempty"` // se_name of RmAddNetworksEventDetails. SeName *string `json:"se_name,omitempty"` // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` // vs_name of RmAddNetworksEventDetails. VsName []string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID []string `json:"vs_uuid,omitempty"` }
RmAddNetworksEventDetails rm add networks event details swagger:model RmAddNetworksEventDetails
type RmAddVnic ¶
type RmAddVnic struct { // network_name of RmAddVnic. NetworkName *string `json:"network_name,omitempty"` // Unique object identifier of network. NetworkUUID *string `json:"network_uuid,omitempty"` // subnet of RmAddVnic. Subnet *string `json:"subnet,omitempty"` }
RmAddVnic rm add vnic swagger:model RmAddVnic
type RmBindVsSeEventDetails ¶
type RmBindVsSeEventDetails struct { // ip of RmBindVsSeEventDetails. IP *string `json:"ip,omitempty"` // ip6 of RmBindVsSeEventDetails. Ip6 *string `json:"ip6,omitempty"` // Placeholder for description of property primary of obj type RmBindVsSeEventDetails field type str type boolean Primary *bool `json:"primary,omitempty"` // se_name of RmBindVsSeEventDetails. SeName *string `json:"se_name,omitempty"` // Placeholder for description of property standby of obj type RmBindVsSeEventDetails field type str type boolean Standby *bool `json:"standby,omitempty"` // type of RmBindVsSeEventDetails. Type *string `json:"type,omitempty"` // vip_vnics of RmBindVsSeEventDetails. VipVnics []string `json:"vip_vnics,omitempty"` // vs_name of RmBindVsSeEventDetails. VsName *string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID *string `json:"vs_uuid,omitempty"` }
RmBindVsSeEventDetails rm bind vs se event details swagger:model RmBindVsSeEventDetails
type RmDeleteSeEventDetails ¶
type RmDeleteSeEventDetails struct { // cloud_name of RmDeleteSeEventDetails. CloudName *string `json:"cloud_name,omitempty"` // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` // host_name of RmDeleteSeEventDetails. HostName *string `json:"host_name,omitempty"` // Unique object identifier of host. HostUUID *string `json:"host_uuid,omitempty"` // reason of RmDeleteSeEventDetails. Reason *string `json:"reason,omitempty"` // se_cookie of RmDeleteSeEventDetails. SeCookie *string `json:"se_cookie,omitempty"` // se_grp_name of RmDeleteSeEventDetails. SeGrpName *string `json:"se_grp_name,omitempty"` // Unique object identifier of se_grp. SeGrpUUID *string `json:"se_grp_uuid,omitempty"` // se_name of RmDeleteSeEventDetails. SeName *string `json:"se_name,omitempty"` // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` // Number of status_code. StatusCode *int64 `json:"status_code,omitempty"` }
RmDeleteSeEventDetails rm delete se event details swagger:model RmDeleteSeEventDetails
type RmModifyNetworksEventDetails ¶
type RmModifyNetworksEventDetails struct { // Placeholder for description of property networks of obj type RmModifyNetworksEventDetails field type str type object Networks []*RmModifyVnic `json:"networks,omitempty"` // reason of RmModifyNetworksEventDetails. Reason *string `json:"reason,omitempty"` // se_name of RmModifyNetworksEventDetails. SeName *string `json:"se_name,omitempty"` // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` // vs_name of RmModifyNetworksEventDetails. VsName []string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID []string `json:"vs_uuid,omitempty"` }
RmModifyNetworksEventDetails rm modify networks event details swagger:model RmModifyNetworksEventDetails
type RmModifyVnic ¶
type RmModifyVnic struct { // mac_addr of RmModifyVnic. MacAddr *string `json:"mac_addr,omitempty"` // network_name of RmModifyVnic. NetworkName *string `json:"network_name,omitempty"` // Unique object identifier of network. NetworkUUID *string `json:"network_uuid,omitempty"` }
RmModifyVnic rm modify vnic swagger:model RmModifyVnic
type RmRebootSeEventDetails ¶
type RmRebootSeEventDetails struct { // reason of RmRebootSeEventDetails. Reason *string `json:"reason,omitempty"` // se_name of RmRebootSeEventDetails. SeName *string `json:"se_name,omitempty"` }
RmRebootSeEventDetails rm reboot se event details swagger:model RmRebootSeEventDetails
type RmSeBootupFailEventDetails ¶
type RmSeBootupFailEventDetails struct { // host_name of RmSeBootupFailEventDetails. HostName *string `json:"host_name,omitempty"` // reason of RmSeBootupFailEventDetails. Reason *string `json:"reason,omitempty"` // se_name of RmSeBootupFailEventDetails. SeName *string `json:"se_name,omitempty"` }
RmSeBootupFailEventDetails rm se bootup fail event details swagger:model RmSeBootupFailEventDetails
type RmSeIPFailEventDetails ¶
type RmSeIPFailEventDetails struct { // host_name of RmSeIpFailEventDetails. HostName *string `json:"host_name,omitempty"` // Placeholder for description of property networks of obj type RmSeIpFailEventDetails field type str type object Networks []*RmAddVnic `json:"networks,omitempty"` // reason of RmSeIpFailEventDetails. Reason *string `json:"reason,omitempty"` // se_name of RmSeIpFailEventDetails. SeName *string `json:"se_name,omitempty"` }
RmSeIPFailEventDetails rm se Ip fail event details swagger:model RmSeIpFailEventDetails
type RmSpawnSeEventDetails ¶
type RmSpawnSeEventDetails struct { // availability_zone of RmSpawnSeEventDetails. AvailabilityZone *string `json:"availability_zone,omitempty"` // cloud_name of RmSpawnSeEventDetails. CloudName *string `json:"cloud_name,omitempty"` // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` // Field introduced in 20.1.2. FlavorName *string `json:"flavor_name,omitempty"` // host_name of RmSpawnSeEventDetails. HostName *string `json:"host_name,omitempty"` // Unique object identifier of host. HostUUID *string `json:"host_uuid,omitempty"` // Number of memory. Memory *int32 `json:"memory,omitempty"` // network_names of RmSpawnSeEventDetails. NetworkNames []string `json:"network_names,omitempty"` // networks of RmSpawnSeEventDetails. Networks []string `json:"networks,omitempty"` // reason of RmSpawnSeEventDetails. Reason *string `json:"reason,omitempty"` // se_cookie of RmSpawnSeEventDetails. SeCookie *string `json:"se_cookie,omitempty"` // se_grp_name of RmSpawnSeEventDetails. SeGrpName *string `json:"se_grp_name,omitempty"` // Unique object identifier of se_grp. SeGrpUUID *string `json:"se_grp_uuid,omitempty"` // se_name of RmSpawnSeEventDetails. SeName *string `json:"se_name,omitempty"` // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` // Number of status_code. StatusCode *int64 `json:"status_code,omitempty"` // Number of vcpus. Vcpus *int32 `json:"vcpus,omitempty"` // vs_name of RmSpawnSeEventDetails. VsName *string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID *string `json:"vs_uuid,omitempty"` }
RmSpawnSeEventDetails rm spawn se event details swagger:model RmSpawnSeEventDetails
type RmUnbindVsSeEventDetails ¶
type RmUnbindVsSeEventDetails struct { // ip of RmUnbindVsSeEventDetails. IP *string `json:"ip,omitempty"` // ip6 of RmUnbindVsSeEventDetails. Ip6 *string `json:"ip6,omitempty"` // reason of RmUnbindVsSeEventDetails. Reason *string `json:"reason,omitempty"` // se_name of RmUnbindVsSeEventDetails. SeName *string `json:"se_name,omitempty"` // vs_name of RmUnbindVsSeEventDetails. VsName *string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID *string `json:"vs_uuid,omitempty"` }
RmUnbindVsSeEventDetails rm unbind vs se event details swagger:model RmUnbindVsSeEventDetails
type Role ¶
type Role struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Filters for granular object access control based on object labels. Multiple filters are merged using the AND operator. If empty, all objects according to the privileges will be accessible to the user. Field introduced in 20.1.3. Maximum of 4 items allowed. Filters []*RoleFilter `json:"filters,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Placeholder for description of property privileges of obj type Role field type str type object Privileges []*Permission `json:"privileges,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
Role role swagger:model Role
type RoleAPIResponse ¶
type RoleAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Role `json:"results,omitempty"` }
RoleAPIResponse role Api response swagger:model RoleApiResponse
type RoleFilter ¶
type RoleFilter struct { // Enable this filter. Field introduced in 20.1.3. Enabled *bool `json:"enabled,omitempty"` // Label key to match against objects for values. Field introduced in 20.1.3. // Required: true MatchLabel *RoleFilterMatchLabel `json:"match_label"` // Label match operation criteria. Enum options - ROLE_FILTER_EQUALS, ROLE_FILTER_DOES_NOT_EQUAL, ROLE_FILTER_GLOB_MATCH, ROLE_FILTER_GLOB_DOES_NOT_MATCH. Field introduced in 20.1.3. MatchOperation *string `json:"match_operation,omitempty"` // Name for the filter. Field introduced in 20.1.3. Name *string `json:"name,omitempty"` }
RoleFilter role filter swagger:model RoleFilter
type RoleFilterMatchLabel ¶
type RoleFilterMatchLabel struct { // Key for filter match. Field introduced in 20.1.3. // Required: true Key *string `json:"key"` // Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Values []string `json:"values,omitempty"` }
RoleFilterMatchLabel role filter match label swagger:model RoleFilterMatchLabel
type RouteInfo ¶
type RouteInfo struct { // Host interface name. Field introduced in 18.2.6. IfName *string `json:"if_name,omitempty"` // Network Namespace type used to add an route entry in a specific namespace. Enum options - LOCAL_NAMESPACE, HOST_NAMESPACE, OTHER_NAMESPACE. Field introduced in 18.2.6. NetworkNamespace *string `json:"network_namespace,omitempty"` // Host nexthop ip address. Field introduced in 18.2.6. Nexthop *IPAddr `json:"nexthop,omitempty"` // Host subnet address. Field introduced in 18.2.6. // Required: true Subnet *IPAddrPrefix `json:"subnet"` }
RouteInfo route info swagger:model RouteInfo
type RoutingService ¶
type RoutingService struct { // Advertise reachability of backend server networks via ADC through BGP for default gateway feature. Field introduced in 18.2.5. AdvertiseBackendNetworks *bool `json:"advertise_backend_networks,omitempty"` // Enable auto gateway to save and use the same L2 path to send the return traffic. Field introduced in 20.1.1. EnableAutoGateway *bool `json:"enable_auto_gateway,omitempty"` // Service Engine acts as Default Gateway for this service. Field introduced in 18.2.5. EnableRouting *bool `json:"enable_routing,omitempty"` // Enable VIP on all interfaces of this service. Field introduced in 18.2.5. EnableVipOnAllInterfaces *bool `json:"enable_vip_on_all_interfaces,omitempty"` // Use Virtual MAC address for interfaces on which floating interface IPs are placed. Field introduced in 18.2.5. EnableVMAC *bool `json:"enable_vmac,omitempty"` // Floating Interface IPs for the RoutingService. Field introduced in 18.2.5. Maximum of 32 items allowed. FloatingIntfIP []*IPAddr `json:"floating_intf_ip,omitempty"` // If ServiceEngineGroup is configured for Legacy 1+1 Active Standby HA Mode, Floating IP's will be advertised only by the Active SE in the Pair. Virtual Services in this group must be disabled/enabled for any changes to the Floating IP's to take effect. Only active SE hosting VS tagged with Active Standby SE 2 Tag will advertise this floating IP when manual load distribution is enabled. Field introduced in 18.2.5. Maximum of 32 items allowed. FloatingIntfIPSe2 []*IPAddr `json:"floating_intf_ip_se_2,omitempty"` // Routing Service related Flow profile information. Field introduced in 18.2.5. FlowtableProfile *FlowtableProfile `json:"flowtable_profile,omitempty"` // Enable graceful restart feature in routing service. For example, BGP. Field introduced in 18.2.6. GracefulRestart *bool `json:"graceful_restart,omitempty"` // NAT policy for outbound NAT functionality. This is done in post-routing. It is a reference to an object of type NatPolicy. Field introduced in 18.2.5. NatPolicyRef *string `json:"nat_policy_ref,omitempty"` // For IP Routing feature, enabling this knob will fallback to routing through Linux, by default routing is done via Service Engine data-path. Field introduced in 18.2.5. RoutingByLinuxIpstack *bool `json:"routing_by_linux_ipstack,omitempty"` }
RoutingService routing service swagger:model RoutingService
type SAMLSPConfig ¶
type SAMLSPConfig struct { // HTTP cookie name for authenticated session. Field introduced in 18.2.3. CookieName *string `json:"cookie_name,omitempty"` // Cookie timeout in minutes. Allowed values are 1-1440. Field introduced in 18.2.3. Unit is MIN. CookieTimeout *int32 `json:"cookie_timeout,omitempty"` // Globally unique SAML entityID for this node. The SAML application entity ID on the IDP should match this. Field introduced in 18.2.3. // Required: true EntityID *string `json:"entity_id"` // Key to generate the cookie. Field introduced in 18.2.3. Key []*HTTPCookiePersistenceKey `json:"key,omitempty"` // SP will use this SSL certificate to sign requests going to the IdP and decrypt the assertions coming from IdP. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 18.2.3. SigningSslKeyAndCertificateRef *string `json:"signing_ssl_key_and_certificate_ref,omitempty"` // SAML Single Signon URL to be programmed on the IDP. Field introduced in 18.2.3. // Required: true SingleSignonURL *string `json:"single_signon_url"` // SAML SP metadata for this application. Field introduced in 18.2.3. // Read Only: true SpMetadata *string `json:"sp_metadata,omitempty"` // By enabling this field IdP can control how long the SP session can exist through the SessionNotOnOrAfter field in the AuthNStatement of SAML Response. Field introduced in 20.1.1. UseIdpSessionTimeout *bool `json:"use_idp_session_timeout,omitempty"` }
SAMLSPConfig s a m l s p config swagger:model SAMLSPConfig
type SCPoolServerStateInfo ¶
type SCPoolServerStateInfo struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Field introduced in 17.1.1. IsServer *bool `json:"is_server,omitempty"` // Field introduced in 17.1.1. OperStatus *OperationalStatus `json:"oper_status,omitempty"` // Field introduced in 17.1.1. PoolID *string `json:"pool_id,omitempty"` // Field introduced in 17.1.1. ServerStates []*SCServerStateInfo `json:"server_states,omitempty"` // It is a reference to an object of type Tenant. Field introduced in 17.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 17.1.1. UUID *string `json:"uuid,omitempty"` }
SCPoolServerStateInfo s c pool server state info swagger:model SCPoolServerStateInfo
type SCPoolServerStateInfoAPIResponse ¶
type SCPoolServerStateInfoAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SCPoolServerStateInfo `json:"results,omitempty"` }
SCPoolServerStateInfoAPIResponse s c pool server state info Api response swagger:model SCPoolServerStateInfoApiResponse
type SCServerStateInfo ¶
type SCServerStateInfo struct { // Field introduced in 17.1.1. OperStatus *OperationalStatus `json:"oper_status,omitempty"` // Field introduced in 17.1.1. ServerIP *IPAddr `json:"server_ip,omitempty"` // Allowed values are 1-65535. Field introduced in 17.1.1. ServerPort *int32 `json:"server_port,omitempty"` }
SCServerStateInfo s c server state info swagger:model SCServerStateInfo
type SCVsStateInfo ¶
type SCVsStateInfo struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Field introduced in 17.1.1. OperStatus *OperationalStatus `json:"oper_status,omitempty"` // It is a reference to an object of type Tenant. Field introduced in 17.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 17.1.1. UUID *string `json:"uuid,omitempty"` // Field introduced in 17.1.1. VipID *string `json:"vip_id,omitempty"` // Field introduced in 17.1.1. VsID *string `json:"vs_id,omitempty"` }
SCVsStateInfo s c vs state info swagger:model SCVsStateInfo
type SCVsStateInfoAPIResponse ¶
type SCVsStateInfoAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SCVsStateInfo `json:"results,omitempty"` }
SCVsStateInfoAPIResponse s c vs state info Api response swagger:model SCVsStateInfoApiResponse
type SEFaultInjectExhaustParam ¶
type SEFaultInjectExhaustParam struct { // Placeholder for description of property leak of obj type SEFaultInjectExhaustParam field type str type boolean Leak *bool `json:"leak,omitempty"` // Number of num. // Required: true Num *int64 `json:"num"` }
SEFaultInjectExhaustParam s e fault inject exhaust param swagger:model SEFaultInjectExhaustParam
type SEFaultInjectSeParam ¶
type SEFaultInjectSeParam struct { // Inject fault in specific core. Field introduced in 18.1.5,18.2.1. Core *int32 `json:"core,omitempty"` // Inject fault in random no of cores. Field introduced in 18.1.5,18.2.1. RandomCore *bool `json:"random_core,omitempty"` // Set se-agent fault type. Enum options - SE_AGENT_FAULT_DISABLED, SE_AGENT_PRE_PROCESS_FAULT, SE_AGENT_POST_PROCESS_FAULT, SE_AGENT_DP_RESPONSE_FAULT, SE_AGENT_RANDOM_PROCESS_FAULT. Field introduced in 18.1.5,18.2.1. SeAgentFault *string `json:"se_agent_fault,omitempty"` // Set se-dp fault type. Enum options - SE_DP_FAULT_DISABLED. Field introduced in 18.1.5,18.2.1. SeDpFault *string `json:"se_dp_fault,omitempty"` }
SEFaultInjectSeParam s e fault inject se param swagger:model SEFaultInjectSeParam
type SSHSeDeployment ¶
type SSHSeDeployment struct { // Host OS distribution e.g. COREOS, UBUNTU, REDHAT. Field deprecated in 17.1.1. HostOs *string `json:"host_os,omitempty"` // Password for ssh and/or sudo. Field deprecated in 17.1.1. Password *string `json:"password,omitempty"` // Username for SSH access to hosts. Field deprecated in 17.1.1. SSHUser *string `json:"ssh_user,omitempty"` // Username for sudo. Field deprecated in 17.1.1. SudoUser *string `json:"sudo_user,omitempty"` }
SSHSeDeployment SSH se deployment swagger:model SSHSeDeployment
type SSLCacheFilter ¶
type SSLCacheFilter struct { // Hexadecimal representation of the SSL session ID. Field introduced in 20.1.1. SslSessionID *string `json:"ssl_session_id,omitempty"` }
SSLCacheFilter s s l cache filter swagger:model SSLCacheFilter
type SSLCertificate ¶
type SSLCertificate struct { // certificate of SSLCertificate. Certificate *string `json:"certificate,omitempty"` // certificate_signing_request of SSLCertificate. CertificateSigningRequest *string `json:"certificate_signing_request,omitempty"` // Placeholder for description of property chain_verified of obj type SSLCertificate field type str type boolean ChainVerified *bool `json:"chain_verified,omitempty"` // Number of days_until_expire. DaysUntilExpire *int32 `json:"days_until_expire,omitempty"` // Enum options - SSL_CERTIFICATE_GOOD, SSL_CERTIFICATE_EXPIRY_WARNING, SSL_CERTIFICATE_EXPIRED. ExpiryStatus *string `json:"expiry_status,omitempty"` // fingerprint of SSLCertificate. Fingerprint *string `json:"fingerprint,omitempty"` // Placeholder for description of property issuer of obj type SSLCertificate field type str type object Issuer *SSLCertificateDescription `json:"issuer,omitempty"` // Placeholder for description of property key_params of obj type SSLCertificate field type str type object KeyParams *SSLKeyParams `json:"key_params,omitempty"` // not_after of SSLCertificate. NotAfter *string `json:"not_after,omitempty"` // not_before of SSLCertificate. NotBefore *string `json:"not_before,omitempty"` // public_key of SSLCertificate. PublicKey *string `json:"public_key,omitempty"` // Placeholder for description of property self_signed of obj type SSLCertificate field type str type boolean SelfSigned *bool `json:"self_signed,omitempty"` // serial_number of SSLCertificate. SerialNumber *string `json:"serial_number,omitempty"` // signature of SSLCertificate. Signature *string `json:"signature,omitempty"` // signature_algorithm of SSLCertificate. SignatureAlgorithm *string `json:"signature_algorithm,omitempty"` // Placeholder for description of property subject of obj type SSLCertificate field type str type object Subject *SSLCertificateDescription `json:"subject,omitempty"` // subjectAltName that provides additional subject identities. SubjectAltNames []string `json:"subject_alt_names,omitempty"` // text of SSLCertificate. Text *string `json:"text,omitempty"` // version of SSLCertificate. Version *string `json:"version,omitempty"` }
SSLCertificate s s l certificate swagger:model SSLCertificate
type SSLCertificateDescription ¶
type SSLCertificateDescription struct { // common_name of SSLCertificateDescription. CommonName *string `json:"common_name,omitempty"` // country of SSLCertificateDescription. Country *string `json:"country,omitempty"` // distinguished_name of SSLCertificateDescription. DistinguishedName *string `json:"distinguished_name,omitempty"` // email_address of SSLCertificateDescription. EmailAddress *string `json:"email_address,omitempty"` // locality of SSLCertificateDescription. Locality *string `json:"locality,omitempty"` // organization of SSLCertificateDescription. Organization *string `json:"organization,omitempty"` // organization_unit of SSLCertificateDescription. OrganizationUnit *string `json:"organization_unit,omitempty"` // state of SSLCertificateDescription. State *string `json:"state,omitempty"` }
SSLCertificateDescription s s l certificate description swagger:model SSLCertificateDescription
type SSLCipherList ¶
type SSLCipherList struct { // List of ciphers from the client's SSL cipher list that could be identified. The ciphers are represented by their RFC name. Enum options - AVI_TLS_NULL_WITH_NULL_NULL, AVI_TLS_RSA_WITH_NULL_MD5, AVI_TLS_RSA_WITH_NULL_SHA, AVI_TLS_RSA_EXPORT_WITH_RC4_40_MD5, AVI_TLS_RSA_WITH_RC4_128_MD5, AVI_TLS_RSA_WITH_RC4_128_SHA, AVI_TLS_RSA_EXPORT_WITH_RC2_CBC_40_MD5, AVI_TLS_RSA_WITH_IDEA_CBC_SHA, AVI_TLS_RSA_EXPORT_WITH_DES40_CBC_SHA, AVI_TLS_RSA_WITH_DES_CBC_SHA, AVI_TLS_RSA_WITH_3DES_EDE_CBC_SHA, AVI_TLS_DH_DSS_EXPORT_WITH_DES40_CBC_SHA, AVI_TLS_DH_DSS_WITH_DES_CBC_SHA, AVI_TLS_DH_DSS_WITH_3DES_EDE_CBC_SHA, AVI_TLS_DH_RSA_EXPORT_WITH_DES40_CBC_SHA, AVI_TLS_DH_RSA_WITH_DES_CBC_SHA, AVI_TLS_DH_RSA_WITH_3DES_EDE_CBC_SHA, AVI_TLS_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA, AVI_TLS_DHE_DSS_WITH_DES_CBC_SHA, AVI_TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA.... Field introduced in 18.1.4, 18.2.1. Maximum of 255 items allowed. IdentifiedCiphers []string `json:"identified_ciphers,omitempty"` // List of ciphers from the client's SSL cipher list, that could not be identified. The ciphers are represented by their RFC 2 byte hex value. Field introduced in 18.1.4, 18.2.1. Maximum of 255 items allowed. UnidentifiedCiphers []string `json:"unidentified_ciphers,omitempty"` }
SSLCipherList s s l cipher list swagger:model SSLCipherList
type SSLClientCertificateAction ¶
type SSLClientCertificateAction struct { // Placeholder for description of property close_connection of obj type SSLClientCertificateAction field type str type boolean CloseConnection *bool `json:"close_connection,omitempty"` // Placeholder for description of property headers of obj type SSLClientCertificateAction field type str type object Headers []*SSLClientRequestHeader `json:"headers,omitempty"` }
SSLClientCertificateAction s s l client certificate action swagger:model SSLClientCertificateAction
type SSLClientRequestHeader ¶
type SSLClientRequestHeader struct { // If this header exists, reset the connection. If the ssl variable is specified, add a header with this value. RequestHeader *string `json:"request_header,omitempty"` // Set the request header with the value as indicated by this SSL variable. Eg. send the whole certificate in PEM format. Enum options - HTTP_POLICY_VAR_CLIENT_IP, HTTP_POLICY_VAR_VS_PORT, HTTP_POLICY_VAR_VS_IP, HTTP_POLICY_VAR_HTTP_HDR, HTTP_POLICY_VAR_SSL_CLIENT_FINGERPRINT, HTTP_POLICY_VAR_SSL_CLIENT_SERIAL, HTTP_POLICY_VAR_SSL_CLIENT_ISSUER, HTTP_POLICY_VAR_SSL_CLIENT_SUBJECT, HTTP_POLICY_VAR_SSL_CLIENT_RAW, HTTP_POLICY_VAR_SSL_PROTOCOL, HTTP_POLICY_VAR_SSL_SERVER_NAME, HTTP_POLICY_VAR_USER_NAME, HTTP_POLICY_VAR_SSL_CIPHER, HTTP_POLICY_VAR_REQUEST_ID. RequestHeaderValue *string `json:"request_header_value,omitempty"` }
SSLClientRequestHeader s s l client request header swagger:model SSLClientRequestHeader
type SSLExpireDetails ¶
type SSLExpireDetails struct { // Number of days until certificate is expired. DaysLeft *int32 `json:"days_left,omitempty"` // Name of SSL Certificate. Name *string `json:"name,omitempty"` }
SSLExpireDetails s s l expire details swagger:model SSLExpireDetails
type SSLExportDetails ¶
type SSLExportDetails struct { // Request user. User *string `json:"user,omitempty"` }
SSLExportDetails s s l export details swagger:model SSLExportDetails
type SSLIgnoredDetails ¶
type SSLIgnoredDetails struct { // Name of SSL Certificate. Name *string `json:"name,omitempty"` // Reason for ignoring certificate. Reason *string `json:"reason,omitempty"` }
SSLIgnoredDetails s s l ignored details swagger:model SSLIgnoredDetails
type SSLKeyAndCertificate ¶
type SSLKeyAndCertificate struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // CA certificates in certificate chain. CaCerts []*CertificateAuthority `json:"ca_certs,omitempty"` // Placeholder for description of property certificate of obj type SSLKeyAndCertificate field type str type object // Required: true Certificate *SSLCertificate `json:"certificate"` // States if the certificate is base64 encoded. CertificateBase64 *bool `json:"certificate_base64,omitempty"` // It is a reference to an object of type CertificateManagementProfile. CertificateManagementProfileRef *string `json:"certificate_management_profile_ref,omitempty"` // Creator name. CreatedBy *string `json:"created_by,omitempty"` // Dynamic parameters needed for certificate management profile. DynamicParams []*CustomParams `json:"dynamic_params,omitempty"` // Enables OCSP Stapling. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableOcspStapling *bool `json:"enable_ocsp_stapling,omitempty"` // Encrypted private key corresponding to the private key (e.g. those generated by an HSM such as Thales nShield). EnckeyBase64 *string `json:"enckey_base64,omitempty"` // Name of the encrypted private key (e.g. those generated by an HSM such as Thales nShield). EnckeyName *string `json:"enckey_name,omitempty"` // Format of the Key/Certificate file. Enum options - SSL_PEM, SSL_PKCS12. Format *string `json:"format,omitempty"` // It is a reference to an object of type HardwareSecurityModuleGroup. HardwaresecuritymodulegroupRef *string `json:"hardwaresecuritymodulegroup_ref,omitempty"` // Private key. Key *string `json:"key,omitempty"` // States if the private key is base64 encoded. KeyBase64 *bool `json:"key_base64,omitempty"` // Placeholder for description of property key_params of obj type SSLKeyAndCertificate field type str type object KeyParams *SSLKeyParams `json:"key_params,omitempty"` // Passphrase used to encrypt the private key. KeyPassphrase *string `json:"key_passphrase,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Configuration related to OCSP. Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. OcspConfig *OCSPConfig `json:"ocsp_config,omitempty"` // Error reported during OCSP status query. Enum options - OCSP_ERR_CERTSTATUS_GOOD, OCSP_ERR_CERTSTATUS_REVOKED, OCSP_ERR_CERTSTATUS_UNKNOWN, OCSP_ERR_CERTSTATUS_SERVERFAIL_ERR, OCSP_ERR_CERTSTATUS_JOBDB, OCSP_ERR_CERTSTATUS_DISABLED, OCSP_ERR_CERTSTATUS_GETCERT, OCSP_ERR_CERTSTATUS_NONVSCERT, OCSP_ERR_CERTSTATUS_SELFSIGNED, OCSP_ERR_CERTSTATUS_CERTFINISH, OCSP_ERR_CERTSTATUS_CACERT, OCSP_ERR_CERTSTATUS_REQUEST, OCSP_ERR_CERTSTATUS_ISSUER_REVOKED, OCSP_ERR_CERTSTATUS_PARSE_CERT, OCSP_ERR_CERTSTATUS_HTTP_REQ, OCSP_ERR_CERTSTATUS_URL_LIST, OCSP_ERR_CERTSTATUS_HTTP_SEND, OCSP_ERR_CERTSTATUS_HTTP_RECV, OCSP_ERR_CERTSTATUS_HTTP_RESP. Field introduced in 20.1.1. Allowed in Basic(Allowed values- OCSP_ERR_CERTSTATUS_DISABLED) edition, Essentials(Allowed values- OCSP_ERR_CERTSTATUS_DISABLED) edition, Enterprise edition. // Read Only: true OcspErrorStatus *string `json:"ocsp_error_status,omitempty"` // This is an Internal field to store the OCSP Responder URLs contained in the certificate. Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. // Read Only: true OcspResponderURLListFromCerts []string `json:"ocsp_responder_url_list_from_certs,omitempty"` // Information related to OCSP response. Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. // Read Only: true OcspResponseInfo *OCSPResponseInfo `json:"ocsp_response_info,omitempty"` // Enum options - SSL_CERTIFICATE_FINISHED, SSL_CERTIFICATE_PENDING. Status *string `json:"status,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - SSL_CERTIFICATE_TYPE_VIRTUALSERVICE, SSL_CERTIFICATE_TYPE_SYSTEM, SSL_CERTIFICATE_TYPE_CA. Type *string `json:"type,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
SSLKeyAndCertificate s s l key and certificate swagger:model SSLKeyAndCertificate
type SSLKeyAndCertificateAPIResponse ¶
type SSLKeyAndCertificateAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SSLKeyAndCertificate `json:"results,omitempty"` }
SSLKeyAndCertificateAPIResponse s s l key and certificate Api response swagger:model SSLKeyAndCertificateApiResponse
type SSLKeyECParams ¶
type SSLKeyECParams struct { // Enum options - SSL_KEY_EC_CURVE_SECP256R1, SSL_KEY_EC_CURVE_SECP384R1, SSL_KEY_EC_CURVE_SECP521R1. Curve *string `json:"curve,omitempty"` }
SSLKeyECParams s s l key e c params swagger:model SSLKeyECParams
type SSLKeyParams ¶
type SSLKeyParams struct { // Enum options - SSL_KEY_ALGORITHM_RSA, SSL_KEY_ALGORITHM_EC. // Required: true Algorithm *string `json:"algorithm"` // Placeholder for description of property ec_params of obj type SSLKeyParams field type str type object EcParams *SSLKeyECParams `json:"ec_params,omitempty"` // Placeholder for description of property rsa_params of obj type SSLKeyParams field type str type object RsaParams *SSLKeyRSAParams `json:"rsa_params,omitempty"` }
SSLKeyParams s s l key params swagger:model SSLKeyParams
type SSLKeyRSAParams ¶
type SSLKeyRSAParams struct { // Number of exponent. Exponent *int32 `json:"exponent,omitempty"` // Enum options - SSL_KEY_1024_BITS, SSL_KEY_2048_BITS, SSL_KEY_3072_BITS, SSL_KEY_4096_BITS. KeySize *string `json:"key_size,omitempty"` }
SSLKeyRSAParams s s l key r s a params swagger:model SSLKeyRSAParams
type SSLProfile ¶
type SSLProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Ciphers suites represented as defined by https //www.openssl.org/docs/apps/ciphers.html. AcceptedCiphers *string `json:"accepted_ciphers,omitempty"` // Set of versions accepted by the server. Minimum of 1 items required. AcceptedVersions []*SSLVersion `json:"accepted_versions,omitempty"` // Enum options - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_GCM_SHA256. Allowed in Basic(Allowed values- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA) edition, Essentials(Allowed values- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA) edition, Enterprise edition. CipherEnums []string `json:"cipher_enums,omitempty"` // TLS 1.3 Ciphers suites represented as defined by U(https //www.openssl.org/docs/manmaster/man1/ciphers.html). Field introduced in 18.2.6. Allowed in Basic edition, Essentials edition, Enterprise edition. Special default for Basic edition is TLS_AES_256_GCM_SHA384-TLS_AES_128_GCM_SHA256, Essentials edition is TLS_AES_256_GCM_SHA384-TLS_AES_128_GCM_SHA256, Enterprise is TLS_AES_256_GCM_SHA384-TLS_CHACHA20_POLY1305_SHA256-TLS_AES_128_GCM_SHA256. Ciphersuites *string `json:"ciphersuites,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // DH Parameters used in SSL. At this time, it is not configurable and is set to 2048 bits. Dhparam *string `json:"dhparam,omitempty"` // Enable early data processing for TLS1.3 connections. Field introduced in 18.2.6. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableEarlyData *bool `json:"enable_early_data,omitempty"` // Enable SSL session re-use. EnableSslSessionReuse *bool `json:"enable_ssl_session_reuse,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Prefer the SSL cipher ordering presented by the client during the SSL handshake over the one specified in the SSL Profile. PreferClientCipherOrdering *bool `json:"prefer_client_cipher_ordering,omitempty"` // Send 'close notify' alert message for a clean shutdown of the SSL connection. SendCloseNotify *bool `json:"send_close_notify,omitempty"` // Placeholder for description of property ssl_rating of obj type SSLProfile field type str type object SslRating *SSLRating `json:"ssl_rating,omitempty"` // The amount of time in seconds before an SSL session expires. Unit is SEC. SslSessionTimeout *int32 `json:"ssl_session_timeout,omitempty"` // Placeholder for description of property tags of obj type SSLProfile field type str type object Tags []*Tag `json:"tags,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // SSL Profile Type. Enum options - SSL_PROFILE_TYPE_APPLICATION, SSL_PROFILE_TYPE_SYSTEM. Field introduced in 17.2.8. Type *string `json:"type,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
SSLProfile s s l profile swagger:model SSLProfile
type SSLProfileAPIResponse ¶
type SSLProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SSLProfile `json:"results,omitempty"` }
SSLProfileAPIResponse s s l profile Api response swagger:model SSLProfileApiResponse
type SSLProfileSelector ¶
type SSLProfileSelector struct { // Configure client IP address groups. Field introduced in 18.2.3. // Required: true ClientIPList *IPAddrMatch `json:"client_ip_list"` // SSL profile for the client IP addresses listed. It is a reference to an object of type SSLProfile. Field introduced in 18.2.3. // Required: true SslProfileRef *string `json:"ssl_profile_ref"` }
SSLProfileSelector s s l profile selector swagger:model SSLProfileSelector
type SSLRating ¶
type SSLRating struct { // Enum options - SSL_SCORE_NOT_SECURE, SSL_SCORE_VERY_BAD, SSL_SCORE_BAD, SSL_SCORE_AVERAGE, SSL_SCORE_GOOD, SSL_SCORE_EXCELLENT. CompatibilityRating *string `json:"compatibility_rating,omitempty"` // Enum options - SSL_SCORE_NOT_SECURE, SSL_SCORE_VERY_BAD, SSL_SCORE_BAD, SSL_SCORE_AVERAGE, SSL_SCORE_GOOD, SSL_SCORE_EXCELLENT. PerformanceRating *string `json:"performance_rating,omitempty"` // security_score of SSLRating. SecurityScore *string `json:"security_score,omitempty"` }
SSLRating s s l rating swagger:model SSLRating
type SSLRenewDetails ¶
type SSLRenewDetails struct { // Name of SSL Certificate. Name *string `json:"name,omitempty"` }
SSLRenewDetails s s l renew details swagger:model SSLRenewDetails
type SSLRenewFailedDetails ¶
type SSLRenewFailedDetails struct { // Error when renewing certificate. Error *string `json:"error,omitempty"` // Name of SSL Certificate. Name *string `json:"name,omitempty"` }
SSLRenewFailedDetails s s l renew failed details swagger:model SSLRenewFailedDetails
type SSLRevokedDetails ¶
type SSLRevokedDetails struct { // Name of SSL Certificate. Field introduced in 20.1.1. Name *string `json:"name,omitempty"` // Certificate revocation reason provided by OCSP Responder. Field introduced in 20.1.1. Reason *string `json:"reason,omitempty"` }
SSLRevokedDetails s s l revoked details swagger:model SSLRevokedDetails
type SSLVersion ¶
type SSLVersion struct { // Enum options - SSL_VERSION_SSLV3, SSL_VERSION_TLS1, SSL_VERSION_TLS1_1, SSL_VERSION_TLS1_2, SSL_VERSION_TLS1_3. Allowed in Basic(Allowed values- SSL_VERSION_SSLV3,SSL_VERSION_TLS1,SSL_VERSION_TLS1_1,SSL_VERSION_TLS1_2) edition, Essentials(Allowed values- SSL_VERSION_SSLV3,SSL_VERSION_TLS1,SSL_VERSION_TLS1_1,SSL_VERSION_TLS1_2) edition, Enterprise edition. // Required: true Type *string `json:"type"` }
SSLVersion s s l version swagger:model SSLVersion
type SSOPolicy ¶
type SSOPolicy struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Authentication Policy Settings. Field introduced in 18.2.1. // Required: true AuthenticationPolicy *AuthenticationPolicy `json:"authentication_policy"` // Authorization Policy Settings. Field introduced in 18.2.5. AuthorizationPolicy *AuthorizationPolicy `json:"authorization_policy,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name of the SSO Policy. Field introduced in 18.2.3. // Required: true Name *string `json:"name"` // UUID of the Tenant. It is a reference to an object of type Tenant. Field introduced in 18.2.3. TenantRef *string `json:"tenant_ref,omitempty"` // SSO Policy Type. Enum options - SSO_TYPE_SAML, SSO_TYPE_PINGACCESS, SSO_TYPE_JWT. Field introduced in 18.2.5. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the SSO Policy. Field introduced in 18.2.3. UUID *string `json:"uuid,omitempty"` }
SSOPolicy s s o policy swagger:model SSOPolicy
type SSOPolicyAPIResponse ¶
type SSOPolicyAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SSOPolicy `json:"results,omitempty"` }
SSOPolicyAPIResponse s s o policy Api response swagger:model SSOPolicyApiResponse
type SamlAttribute ¶
type SamlAttribute struct { // SAML Attribute name. Field introduced in 20.1.1. AttrName *string `json:"attr_name,omitempty"` // SAML Attribute values. Field introduced in 20.1.1. AttrValues []string `json:"attr_values,omitempty"` }
SamlAttribute saml attribute swagger:model SamlAttribute
type SamlAuthnRuleMatch ¶
type SamlAuthnRuleMatch struct { // Name of the executed SAML Authentication rule Action. Enum options - SKIP_AUTHENTICATION, USE_DEFAULT_AUTHENTICATION. Field introduced in 20.1.1. SamlAuthnMatchedRuleAction *string `json:"saml_authn_matched_rule_action,omitempty"` // Name of the matched SAML Authentication rule. Field introduced in 20.1.1. SamlAuthnMatchedRuleName *string `json:"saml_authn_matched_rule_name,omitempty"` }
SamlAuthnRuleMatch saml authn rule match swagger:model SamlAuthnRuleMatch
type SamlAuthzRuleMatch ¶
type SamlAuthzRuleMatch struct { // Name of the executed SAML Authorization rule Action. Enum options - ALLOW_ACCESS, CLOSE_CONNECTION, HTTP_LOCAL_RESPONSE. Field introduced in 20.1.1. SamlAuthzMatchedRuleAction *string `json:"saml_authz_matched_rule_action,omitempty"` // Name of the matched SAML Authorization rule. Field introduced in 20.1.1. SamlAuthzMatchedRuleName *string `json:"saml_authz_matched_rule_name,omitempty"` }
SamlAuthzRuleMatch saml authz rule match swagger:model SamlAuthzRuleMatch
type SamlIdentityProviderSettings ¶
type SamlIdentityProviderSettings struct { // SAML IDP metadata. Field introduced in 17.2.3. Metadata *string `json:"metadata,omitempty"` }
SamlIdentityProviderSettings saml identity provider settings swagger:model SamlIdentityProviderSettings
type SamlLog ¶
type SamlLog struct { // Set to True if SAML Authentication is used. Field introduced in 20.1.1. IsSamlAuthenticationUsed *bool `json:"is_saml_authentication_used,omitempty"` // SAML Attribute list. Field introduced in 20.1.1. SamlAttributeLists []*SamlAttribute `json:"saml_attribute_lists,omitempty"` // Saml Authentication Status. Enum options - SAML_AUTH_STATUS_UNAVAILABLE, SAML_AUTH_STATUS_UNAUTH_GET_REQUEST, SAML_AUTH_STATUS_UNAUTH_REQ_UNSUPPORTED_METHOD, SAML_AUTH_STATUS_AUTH_REQUEST_GENERATED, SAML_AUTH_STATUS_AUTH_RESPONSE_RECEIVED, SAML_AUTH_STATUS_AUTHENTICATED_REQUEST, SAML_AUTH_STATUS_AUTHORIZATION_FAILED. Field introduced in 20.1.1. SamlAuthStatus *string `json:"saml_auth_status,omitempty"` // SAML Authentication rule match. Field introduced in 20.1.1. SamlAuthnRuleMatch *SamlAuthnRuleMatch `json:"saml_authn_rule_match,omitempty"` // SAML Authorization rule match. Field introduced in 20.1.1. SamlAuthzRuleMatch *SamlAuthzRuleMatch `json:"saml_authz_rule_match,omitempty"` // Is set when SAML session cookie is expired. Field introduced in 20.1.1. SamlSessionCookieExpired *bool `json:"saml_session_cookie_expired,omitempty"` // SAML userid. Field introduced in 20.1.1. Userid *string `json:"userid,omitempty"` }
SamlLog saml log swagger:model SamlLog
type SamlServiceProviderNode ¶
type SamlServiceProviderNode struct { // Globally unique entityID for this node. Entity ID on the IDP should match this. Field introduced in 17.2.3. EntityID *string `json:"entity_id,omitempty"` // Refers to the Cluster name identifier (Virtual IP or FQDN). Field introduced in 17.2.3. // Required: true Name *string `json:"name"` // Service Provider signing certificate for metadata. Field deprecated in 18.2.1. Field introduced in 17.2.3. SigningCert *string `json:"signing_cert,omitempty"` // Service Provider signing key for metadata. Field deprecated in 18.2.1. Field introduced in 17.2.3. SigningKey *string `json:"signing_key,omitempty"` // Service Engines will use this SSL certificate to sign assertions going to the IdP. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 18.2.1. SigningSslKeyAndCertificateRef *string `json:"signing_ssl_key_and_certificate_ref,omitempty"` // Single Signon URL to be programmed on the IDP. Field introduced in 17.2.3. SingleSignonURL *string `json:"single_signon_url,omitempty"` }
SamlServiceProviderNode saml service provider node swagger:model SamlServiceProviderNode
type SamlServiceProviderSettings ¶
type SamlServiceProviderSettings struct { // FQDN if entity type is DNS_FQDN . Field introduced in 17.2.3. Fqdn *string `json:"fqdn,omitempty"` // Service Provider Organization Display Name. Field introduced in 17.2.3. OrgDisplayName *string `json:"org_display_name,omitempty"` // Service Provider Organization Name. Field introduced in 17.2.3. OrgName *string `json:"org_name,omitempty"` // Service Provider Organization URL. Field introduced in 17.2.3. OrgURL *string `json:"org_url,omitempty"` // Type of SAML endpoint. Enum options - AUTH_SAML_CLUSTER_VIP, AUTH_SAML_DNS_FQDN, AUTH_SAML_APP_VS. Field introduced in 17.2.3. SamlEntityType *string `json:"saml_entity_type,omitempty"` // Service Provider node information. Field introduced in 17.2.3. SpNodes []*SamlServiceProviderNode `json:"sp_nodes,omitempty"` // Service Provider technical contact email. Field introduced in 17.2.3. TechContactEmail *string `json:"tech_contact_email,omitempty"` // Service Provider technical contact name. Field introduced in 17.2.3. TechContactName *string `json:"tech_contact_name,omitempty"` }
SamlServiceProviderSettings saml service provider settings swagger:model SamlServiceProviderSettings
type SamlSettings ¶
type SamlSettings struct { // Configure remote Identity provider settings. Field introduced in 17.2.3. Idp *SamlIdentityProviderSettings `json:"idp,omitempty"` // Configure service provider settings for the Controller. Field introduced in 17.2.3. // Required: true Sp *SamlServiceProviderSettings `json:"sp"` }
SamlSettings saml settings swagger:model SamlSettings
type ScaleStatus ¶
type ScaleStatus struct { // Enum options - OTHER, CREATE, READ, UPDATE, DELETE, SCALE_OUT, SCALE_IN, SE_REMOVED, SE_DISCONNECT, SE_RECONNECT, WARM_RESTART, COLD_RESTART, UPDATE_LOGMGR_MAP, MIGRATE_SCALEOUT, MIGRATE_SCALEIN, INITIAL_PLACEMENT, ROTATE_KEYS, GLB_MGR_UPDATE, UPDATE_DNS_RECORDS, SCALEOUT_ADMINUP, SCALEIN_ADMINDOWN, SCALEOUT_READY, SCALEIN_READY, SE_PRERELEASED, SE_ADDED, SE_PRERELEASE, SE_SCALING_IN, SE_DELETING, SE_PRERELEASE_FAILED, SE_SCALEOUT_FAILED, SCALEOUT_ROLLEDBACK, RSRC_UPDATE, SE_UPDATED, GLB_MGR_UPDATE_GS_STATUS, NEW_PRIMARY, SE_FORCE_RELEASE, SWITCHOVER, SE_ASSIGN_NO_CHANGE, GLB_MGR_DNS_GEO_UPDATE, GLB_MGR_DNS_CLEANUP, NEW_STANDBY, CONNECTED, NOT_CONNECTED, NOT_AT_CURR_VERSION, AT_CURR_VERSION, ATTACH_IP_SUCCESS, SEGROUP_CHANGED, VS_ENABLED, VS_DISABLED, UPDATE_DURING_WARMSTART, RSRC_UPDATE_DURING_WARMSTART, WARMSTART_PARENT_NOT_FOUND, WARMSTART_PARENT_SELIST_MISMATCH, WARMSTART_PARENT_SEGROUP_MISMATCH, WARMSTART_RESYNC_SENT, WARMSTART_RESYNC_RESPONSE, RPC_TO_RESMGR_FAILED, SCALEOUT_READY_IGNORED, SCALEOUT_READY_TIMEDOUT, SCALEOUT_READY_DISCONNECTED, FORCE_SCALEIN_POST_WARMSTART, MIGRATE_SCALEIN_SKIPPED, MIGRATE_DISRUPTED, APIC_PLACEMENT, SE_VIP_MAC_UPDATE, MIN_SCALEOUT_UPDATED, VIP_CHANGE_DISRUPTIVE, POOL_CHANGE_DISRUPTIVE, ECMP_CHANGE_DISRUPTIVE, ENABLE_RHI_CHANGE_DISRUPTIVE, VIP_AS_SNAT_CHANGE_DISRUPTIVE, SE_GROUP_CHANGE_DISRUPTIVE, PARENT_VS_CHANGE_DISRUPTIVE, SNAT_POOL_CHANGE_DISRUPTIVE, UNSET_USE_VIP_AS_SNAT, SE_MGMTIP_CHANGE. Field introduced in 17.1.1. Action *string `json:"action,omitempty"` // Field introduced in 18.1.1. ActionSuccess *bool `json:"action_success,omitempty"` // end_time_str of ScaleStatus. EndTimeStr *string `json:"end_time_str,omitempty"` // Number of num_se_assigned. NumSeAssigned *int32 `json:"num_se_assigned,omitempty"` // Number of num_se_requested. NumSeRequested *int32 `json:"num_se_requested,omitempty"` // Field introduced in 18.2.6. PlacementReadFailCnt *int32 `json:"placement_read_fail_cnt,omitempty"` // reason of ScaleStatus. Reason []string `json:"reason,omitempty"` // Number of reason_code. ReasonCode *int64 `json:"reason_code,omitempty"` // reason_code_string of ScaleStatus. ReasonCodeString *string `json:"reason_code_string,omitempty"` // scale_se of ScaleStatus. ScaleSe *string `json:"scale_se,omitempty"` // start_time_str of ScaleStatus. StartTimeStr *string `json:"start_time_str,omitempty"` // Enum options - SCALEOUT_PROCESSING. SCALEOUT_AWAITING_SE_ASSIGNMENT. SCALEOUT_CREATING_SE. SCALEOUT_RESOURCES. SCALEOUT_AWAITING_SE_PROGRAMMING. SCALEOUT_WAIT_FOR_SE_READY. SCALEOUT_SUCCESS. SCALEOUT_ERROR. SCALEOUT_ROLLBACK. SCALEOUT_ERROR_DISABLED. SCALEIN_AWAITING_SE_PRE_RELEASE. SCALEIN_AWAITING_SE_PROGRAMMING. SCALEIN_WAIT_FOR_SE_READY. SCALEIN_AWAITING_SE_RELEASE. SCALEIN_SUCCESS. SCALEIN_ERROR. MIGRATE_SCALEOUT_AWAITING_SE_ASSIGNMENT. MIGRATE_SCALEOUT_CREATING_SE. MIGRATE_SCALEOUT_RESOURCES. MIGRATE_SCALEOUT_AWAITING_SE_PROGRAMMING... State *string `json:"state,omitempty"` // Placeholder for description of property vip_placement_resolution_info of obj type ScaleStatus field type str type object VipPlacementResolutionInfo *VipPlacementResolutionInfo `json:"vip_placement_resolution_info,omitempty"` }
ScaleStatus scale status swagger:model ScaleStatus
type Scheduler ¶
type Scheduler struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Backup Configuration to be executed by this scheduler. It is a reference to an object of type BackupConfiguration. BackupConfigRef *string `json:"backup_config_ref,omitempty"` // Placeholder for description of property enabled of obj type Scheduler field type str type boolean Enabled *bool `json:"enabled,omitempty"` // Scheduler end date and time. EndDateTime *string `json:"end_date_time,omitempty"` // Frequency at which CUSTOM scheduler will run. Allowed values are 0-60. Frequency *int32 `json:"frequency,omitempty"` // Unit at which CUSTOM scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. FrequencyUnit *string `json:"frequency_unit,omitempty"` // Name of scheduler. // Required: true Name *string `json:"name"` // Scheduler Run Mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. RunMode *string `json:"run_mode,omitempty"` // Control script to be executed by this scheduler. It is a reference to an object of type AlertScriptConfig. RunScriptRef *string `json:"run_script_ref,omitempty"` // Define Scheduler Action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. SchedulerAction *string `json:"scheduler_action,omitempty"` // Scheduler start date and time. StartDateTime *string `json:"start_date_time,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
Scheduler scheduler swagger:model Scheduler
type SchedulerAPIResponse ¶
type SchedulerAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Scheduler `json:"results,omitempty"` }
SchedulerAPIResponse scheduler Api response swagger:model SchedulerApiResponse
type SchedulerActionDetails ¶
type SchedulerActionDetails struct { // backup_uri of SchedulerActionDetails. BackupURI []string `json:"backup_uri,omitempty"` // control_script_output of SchedulerActionDetails. ControlScriptOutput *string `json:"control_script_output,omitempty"` // execution_datestamp of SchedulerActionDetails. ExecutionDatestamp *string `json:"execution_datestamp,omitempty"` // Unique object identifier of scheduler. SchedulerUUID *string `json:"scheduler_uuid,omitempty"` // status of SchedulerActionDetails. Status *string `json:"status,omitempty"` }
SchedulerActionDetails scheduler action details swagger:model SchedulerActionDetails
type SeAgentProperties ¶
type SeAgentProperties struct { // Aggressive Count of HB misses for se health check failure. Allowed values are 1-1000. ControllerEchoMissAggressiveLimit *int32 `json:"controller_echo_miss_aggressive_limit,omitempty"` // Count of HB misses for se health check failure. Allowed values are 1-1000. ControllerEchoMissLimit *int32 `json:"controller_echo_miss_limit,omitempty"` // Aggressive Timeout used for se health check. Unit is MILLISECONDS. ControllerEchoRPCAggressiveTimeout *int32 `json:"controller_echo_rpc_aggressive_timeout,omitempty"` // Timeout used for se health check. Unit is MILLISECONDS. ControllerEchoRPCTimeout *int32 `json:"controller_echo_rpc_timeout,omitempty"` // Allowed values are 1-20. ControllerHeartbeatMissLimit *int32 `json:"controller_heartbeat_miss_limit,omitempty"` // Allowed values are 1-60. Unit is SEC. ControllerHeartbeatTimeoutSec *int32 `json:"controller_heartbeat_timeout_sec,omitempty"` // Unit is SEC. ControllerRegistrationTimeoutSec *int32 `json:"controller_registration_timeout_sec,omitempty"` // Unit is SEC. ControllerRPCTimeout *int32 `json:"controller_rpc_timeout,omitempty"` // Unit is SEC. CpustatsInterval *int32 `json:"cpustats_interval,omitempty"` // Max time to wait for ctrl registration before assert. Allowed values are 1-1000. Unit is SEC. CtrlRegPendingMaxWaitTime *int32 `json:"ctrl_reg_pending_max_wait_time,omitempty"` // Placeholder for description of property debug_mode of obj type SeAgentProperties field type str type boolean DebugMode *bool `json:"debug_mode,omitempty"` // Deprecated in 21.1.1. Use dp_aggressive_deq_interval_msec in ServiceEngineGroup instead. Allowed values are 1-1000. Unit is MILLISECONDS. DpAggressiveDeqIntervalMsec *int32 `json:"dp_aggressive_deq_interval_msec,omitempty"` // Deprecated in 21.1.1. Use dp_aggressive_enq_interval_msec in ServiceEngineGroup instead. Allowed values are 1-1000. Unit is MILLISECONDS. DpAggressiveEnqIntervalMsec *int32 `json:"dp_aggressive_enq_interval_msec,omitempty"` // Number of dp_batch_size. DpBatchSize *int32 `json:"dp_batch_size,omitempty"` // Deprecated in 21.1.1. Use dp_deq_interval_msec in ServiceEngineGroup instead. Allowed values are 1-1000. Unit is MILLISECONDS. DpDeqIntervalMsec *int32 `json:"dp_deq_interval_msec,omitempty"` // Deprecated in 21.1.1. Use dp_enq_interval_msec in ServiceEngineGroup instead. Allowed values are 1-1000. Unit is MILLISECONDS. DpEnqIntervalMsec *int32 `json:"dp_enq_interval_msec,omitempty"` // Unit is SEC. DpMaxWaitRspTimeSec *int32 `json:"dp_max_wait_rsp_time_sec,omitempty"` // Max time to wait for dp registration before assert. Unit is SEC. DpRegPendingMaxWaitTime *int32 `json:"dp_reg_pending_max_wait_time,omitempty"` // Unit is SEC. HeadlessTimeoutSec *int32 `json:"headless_timeout_sec,omitempty"` // Placeholder for description of property ignore_docker_mac_change of obj type SeAgentProperties field type str type boolean IgnoreDockerMacChange *bool `json:"ignore_docker_mac_change,omitempty"` // Dequeue interval for receive queue from NS HELPER. Deprecated in 21.1.1. Use ns_helper_deq_interval_msec in ServiceEngineGroup instead. Allowed values are 1-1000. Field introduced in 17.2.13, 18.1.3, 18.2.1. Unit is MILLISECONDS. NsHelperDeqIntervalMsec *int32 `json:"ns_helper_deq_interval_msec,omitempty"` // SDB pipeline flush interval. Allowed values are 1-10000. Unit is MILLISECONDS. SdbFlushInterval *int32 `json:"sdb_flush_interval,omitempty"` // SDB pipeline size. Allowed values are 1-10000. SdbPipelineSize *int32 `json:"sdb_pipeline_size,omitempty"` // SDB scan count. Allowed values are 1-1000. SdbScanCount *int32 `json:"sdb_scan_count,omitempty"` // Internal flag used to decide if SE restart is needed,when the se-group is changed. Field introduced in 18.2.3. SeGrpChangeDisruptive *bool `json:"se_grp_change_disruptive,omitempty"` // SeAgent properties for State Cache functionality. Field introduced in 18.2.5. SeagentStatecacheProperties *SeAgentStateCacheProperties `json:"seagent_statecache_properties,omitempty"` // Timeout for sending SE_READY without NS HELPER registration completion. Deprecated in 21.1.1. Use send_se_ready_timeout ServiceEngineGroup instead. Allowed values are 10-600. Field introduced in 17.2.13, 18.1.3, 18.2.1. Unit is SECONDS. SendSeReadyTimeout *int32 `json:"send_se_ready_timeout,omitempty"` // Interval for update of operational states to controller. Allowed values are 1-10000. Field introduced in 18.2.1, 17.2.14, 18.1.5. Unit is MILLISECONDS. StatesFlushInterval *int32 `json:"states_flush_interval,omitempty"` // DHCP ip check interval. Deprecated in 21.1.1. Use vnic_dhcp_ip_check_interval instead. Allowed values are 1-1000. Unit is SEC. VnicDhcpIPCheckInterval *int32 `json:"vnic_dhcp_ip_check_interval,omitempty"` // DHCP ip max retries. Deprecated in 21.1.1. Use vnic_dhcp_ip_max_retries ServiceEngineGroup instead. VnicDhcpIPMaxRetries *int32 `json:"vnic_dhcp_ip_max_retries,omitempty"` // wait interval before deleting IP. Deprecated in 21.1.1. Use vnic_ip_delete_interval ServiceEngineGroup instead. Unit is SEC. VnicIPDeleteInterval *int32 `json:"vnic_ip_delete_interval,omitempty"` // Probe vnic interval. Deprecated in 21.1.1. Use vnic_probe_interval ServiceEngineGroup instead. Unit is SEC. VnicProbeInterval *int32 `json:"vnic_probe_interval,omitempty"` // Time interval for retrying the failed VNIC RPC requestsDeprecated in 21.1.1. Use vnic_rpc_retry_interval ServiceEngineGroup instead. Field introduced in 18.2.6. Unit is SEC. VnicRPCRetryInterval *int32 `json:"vnic_rpc_retry_interval,omitempty"` // Size of vnicdb command history. Deprecated in 21.1.1. Use vnicdb_cmd_history_size ServiceEngineGroup instead. Allowed values are 0-65535. Field introduced in 18.2.3. VnicdbCmdHistorySize *int32 `json:"vnicdb_cmd_history_size,omitempty"` }
SeAgentProperties se agent properties swagger:model SeAgentProperties
type SeAgentStateCacheProperties ¶
type SeAgentStateCacheProperties struct { // Max elements to flush in one shot from the internal buffer by the statecache thread. Allowed values are 1-10000. Field introduced in 18.2.5. ScBatchBufferFlushLimit *int32 `json:"sc_batch_buffer_flush_limit,omitempty"` // Max time to wait by the statecache thread before cleaning up connection to the controller shard. Allowed values are 1-1000000. Field introduced in 18.2.5. Unit is SECONDS. ScShardCleanupMaxTime *int32 `json:"sc_shard_cleanup_max_time,omitempty"` // Max elements to dequeue in one shot from the state_ring by the statecache thread. Allowed values are 1-10000. Field introduced in 18.2.5. ScStateRingBatchDequeueLimit *int32 `json:"sc_state_ring_batch_dequeue_limit,omitempty"` // Interval for update of operational states to controller. Allowed values are 1-10000. Field introduced in 18.2.5. Unit is MILLISECONDS. ScStatesFlushInterval *int32 `json:"sc_states_flush_interval,omitempty"` // Interval for checking health of grpc streams to statecache_mgr. Allowed values are 1-90000. Field introduced in 18.2.5. Unit is MILLISECONDS. ScStreamCheckInterval *int32 `json:"sc_stream_check_interval,omitempty"` // Max elements to dequeue in one shot from the Q by the statecache thread. Allowed values are 1-10000. Field introduced in 18.2.5. ScThreadQBatchDequeueLimit *int32 `json:"sc_thread_q_batch_dequeue_limit,omitempty"` // Max elements in the Q between seagent main and the statecache thread. Allowed values are 1-10000. Field introduced in 18.2.5. ScThreadQMaxSize *int32 `json:"sc_thread_q_max_size,omitempty"` // Interval for grpc thread to sleep between doing work. Allowed values are 1-10000. Field introduced in 18.2.5. Unit is MILLISECONDS. ScThreadSleepInterval *int32 `json:"sc_thread_sleep_interval,omitempty"` }
SeAgentStateCacheProperties se agent state cache properties swagger:model SeAgentStateCacheProperties
type SeBgpPeerDownDetails ¶
type SeBgpPeerDownDetails struct { // Message specific to the down condition. Field introduced in 20.1.1. Message *string `json:"message,omitempty"` // IP address of BGP peer. Field introduced in 20.1.1. // Required: true PeerIP *string `json:"peer_ip"` // Name of Virtual Routing Context in which BGP is configured. Field introduced in 20.1.1. VrfName *string `json:"vrf_name,omitempty"` }
SeBgpPeerDownDetails se bgp peer down details swagger:model SeBgpPeerDownDetails
type SeBgpPeerStateChangeDetails ¶
type SeBgpPeerStateChangeDetails struct { // IP address of BGP peer. Field introduced in 17.2.1. // Required: true PeerIP *string `json:"peer_ip"` // BGP peer state. Field introduced in 17.2.1. // Required: true PeerState *string `json:"peer_state"` // Name of Virtual Routing Context in which BGP is configured. Field introduced in 17.2.1. VrfName *string `json:"vrf_name,omitempty"` }
SeBgpPeerStateChangeDetails se bgp peer state change details swagger:model SeBgpPeerStateChangeDetails
type SeBootupCompressionProperties ¶
type SeBootupCompressionProperties struct { // Number of buffers to use for compression output. BufNum *int32 `json:"buf_num,omitempty"` // Size of each buffer used for compression output, this should ideally be a multiple of pagesize. BufSize *int32 `json:"buf_size,omitempty"` // hash size used by compression, rounded to the last power of 2. HashSize *int32 `json:"hash_size,omitempty"` // Level of compression to apply on content selected for aggressive compression. LevelAggressive *int32 `json:"level_aggressive,omitempty"` // Level of compression to apply on content selected for normal compression. LevelNormal *int32 `json:"level_normal,omitempty"` // window size used by compression, rounded to the last power of 2. WindowSize *int32 `json:"window_size,omitempty"` }
SeBootupCompressionProperties se bootup compression properties swagger:model SeBootupCompressionProperties
type SeBootupProperties ¶
type SeBootupProperties struct { // Deprecated. Field deprecated in 17.2.8. Field introduced in 17.1.1. DistributeQueues *bool `json:"distribute_queues,omitempty"` // Deprecated. Field deprecated in 18.2.5. DistributeVnics *bool `json:"distribute_vnics,omitempty"` // End of the Local TCP port range used by SE for backend connections in docker environment. DockerBackendPortend *int32 `json:"docker_backend_portend,omitempty"` // Start of the Local TCP port range used by SE for backend connections in docker environment. DockerBackendPortstart *int32 `json:"docker_backend_portstart,omitempty"` // Enable or disable fair queueing for packet transmission among virtualservices on an SE. FairQueueingEnabled *bool `json:"fair_queueing_enabled,omitempty"` // Granularity or Resolution of co-ordinates used. When the value is 1 the co-ordinates provided in the geo-db are used as is (highest resolution.This value provides a 'zoom-out' value so that coarser co-ordinates are used. With higher resolution, logs can contain finer location information. But, lower resolution provides significant memory and cpu benefits on the service engine. Besides, given a smaller number of members that are separated geographically, a lower resolution is sufficient for correct load-balancing. Allowed values are 1-20. Field introduced in 17.1.1. Allowed in Basic(Allowed values- 1) edition, Essentials(Allowed values- 1) edition, Enterprise edition. GeoDbGranularity *int32 `json:"geo_db_granularity,omitempty"` // Number of L7 connections that can be cached per core. L7ConnsPerCore *int32 `json:"l7_conns_per_core,omitempty"` // Number of reserved L7 listener connections per core. L7ResvdListenConnsPerCore *int32 `json:"l7_resvd_listen_conns_per_core,omitempty"` // Enable debug logs by default on Service Engine. This includes all other debugging logs. Debug logs can also be explcitly enabled from the CLI shell. LogAgentDebugEnabled *bool `json:"log_agent_debug_enabled,omitempty"` // Enable trace logs by default on Service Engine. Configuration operations are logged along with other important logs by Service Engine. LogAgentTraceEnabled *bool `json:"log_agent_trace_enabled,omitempty"` // Placeholder for description of property se_dp_compression of obj type SeBootupProperties field type str type object SeDpCompression *SeBootupCompressionProperties `json:"se_dp_compression,omitempty"` // This field has been moved to se_group properties 18.1.2 onwards. Field deprecated in 18.1.3. SeDpdkPmd *int32 `json:"se_dpdk_pmd,omitempty"` // Use this to emulate more/less cpus than is actually available. One datapath process is started for each core. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. SeEmulatedCores *int32 `json:"se_emulated_cores,omitempty"` // Determines if SE-SE IPC messages are encapsulated in an IP header Note This field has been moved to se_group properties 20.1.3 onwards. 0 Automatically determine based on hypervisor type 1 Use IP encap unconditionally ~[0,1] Don't use IP encap. SeIPEncapIpc *int32 `json:"se_ip_encap_ipc,omitempty"` // Determines if SE-SE IPC messages use SE interface IP instead of VIP Note This field has been moved to se_group properties 20.1.3 onwards. 0 Automatically determine based on hypervisor type 1 Use SE interface IP unconditionally ~[0,1] Don't use SE interface IP. SeL3EncapIpc *int32 `json:"se_l3_encap_ipc,omitempty"` // Internal flag that blocks dataplane until all application logs are flushed to log-agent process. SeLogBufferAppBlockingDequeue *bool `json:"se_log_buffer_app_blocking_dequeue,omitempty"` // Internal application log buffer size to use on Service Engine. Can be fine tuned for better performance of data plane in specific environments. Unit is WORD. SeLogBufferApplogSize *int32 `json:"se_log_buffer_applog_size,omitempty"` // Number of internal buffer chunks to use on Service Engine. Can be fine tuned for better performance of data plane in specific environments. Unit is BYTES. SeLogBufferChunkCount *int32 `json:"se_log_buffer_chunk_count,omitempty"` // Internal flag that blocks dataplane until all connection logs are flushed to log-agent process. SeLogBufferConnBlockingDequeue *bool `json:"se_log_buffer_conn_blocking_dequeue,omitempty"` // Internal connection log buffer size to use on Service Engine. Can be fine tuned for better performance of data plane in specific environments. Unit is WORD. SeLogBufferConnlogSize *int32 `json:"se_log_buffer_connlog_size,omitempty"` // Internal flag that blocks dataplane until all outstanding events are flushed to log-agent process. SeLogBufferEventsBlockingDequeue *bool `json:"se_log_buffer_events_blocking_dequeue,omitempty"` // Internal events buffer size to use on Service Engine. Can be fine tuned for better performance of data plane in specific environments. Unit is WORD. SeLogBufferEventsSize *int32 `json:"se_log_buffer_events_size,omitempty"` // Deprecated. Field deprecated in 18.2.5. SeLro *int32 `json:"se_lro,omitempty"` // Deprecated. Field deprecated in 18.2.5. SePcapPktCount *int32 `json:"se_pcap_pkt_count,omitempty"` // Deprecated. Field deprecated in 18.2.5. SePcapPktSz *int32 `json:"se_pcap_pkt_sz,omitempty"` SeRumSamplingNavInterval *int32 `json:"se_rum_sampling_nav_interval,omitempty"` SeRumSamplingNavPercent *int32 `json:"se_rum_sampling_nav_percent,omitempty"` // Deprecated. Field deprecated in 18.2.6. SeRumSamplingResInterval *int32 `json:"se_rum_sampling_res_interval,omitempty"` // Deprecated. Field deprecated in 18.2.6. SeRumSamplingResPercent *int32 `json:"se_rum_sampling_res_percent,omitempty"` // Determines if DSR from secondary SE is active or not 0 Automatically determine based on hypervisor type 1 Disable DSR unconditionally ~[0,1] Enable DSR unconditionally. Field deprecated in 17.1.1. SeTunnelMode *int32 `json:"se_tunnel_mode,omitempty"` // Deprecated. Field deprecated in 18.2.5. SeTxBatchSize *int32 `json:"se_tx_batch_size,omitempty"` // This field has been moved to se_group properties 18.1.2 onwards. Field deprecated in 18.1.3. SeUseDpdk *int32 `json:"se_use_dpdk,omitempty"` // Number of ssl_sess_cache_per_vs. SslSessCachePerVs *int32 `json:"ssl_sess_cache_per_vs,omitempty"` // Number of ssl_sess_cache_timeout. SslSessCacheTimeout *int32 `json:"ssl_sess_cache_timeout,omitempty"` // Size of the TCP SYN cache hash table. TCPSyncacheHashsize *int32 `json:"tcp_syncache_hashsize,omitempty"` }
SeBootupProperties se bootup properties swagger:model SeBootupProperties
type SeDiscontinuousTimeChangeEventDetails ¶
type SeDiscontinuousTimeChangeEventDetails struct { // Relative time drift between SE and controller in terms of microseconds. DriftTime *int64 `json:"drift_time,omitempty"` // Time stamp before the discontinuous jump in time. FromTime *string `json:"from_time,omitempty"` // Name of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeName *string `json:"se_name,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` // Time stamp to which the time has discontinuously jumped. ToTime *string `json:"to_time,omitempty"` }
SeDiscontinuousTimeChangeEventDetails se discontinuous time change event details swagger:model SeDiscontinuousTimeChangeEventDetails
type SeDupipEventDetails ¶
type SeDupipEventDetails struct { // Mac Address. LocalMac *string `json:"local_mac,omitempty"` // Mac Address. RemoteMac *string `json:"remote_mac,omitempty"` // Vnic IP. VnicIP *string `json:"vnic_ip,omitempty"` // Vnic name. VnicName *string `json:"vnic_name,omitempty"` }
SeDupipEventDetails se dupip event details swagger:model SeDupipEventDetails
type SeFault ¶
type SeFault struct { // Optional 64 bit unsigned integer that can be used within the enabled fault. Field introduced in 20.1.1. Arg *int64 `json:"arg,omitempty"` // The name of the target fault. Field introduced in 20.1.1. // Required: true FaultName *string `json:"fault_name"` // The name of the function that contains the target fault. Field introduced in 20.1.1. FunctionName *string `json:"function_name,omitempty"` // Number of times the fault should be executed. Allowed values are 1-4294967295. Field introduced in 20.1.1. NumExecutions *int32 `json:"num_executions,omitempty"` // Number of times the fault should be skipped before executing. Field introduced in 18.2.9. NumSkips *int32 `json:"num_skips,omitempty"` }
SeFault se fault swagger:model SeFault
type SeGatewayHeartbeatFailedDetails ¶
type SeGatewayHeartbeatFailedDetails struct { // IP address of gateway monitored. // Required: true GatewayIP *string `json:"gateway_ip"` // Name of Virtual Routing Context in which this gateway is present. VrfName *string `json:"vrf_name,omitempty"` // UUID of the Virtual Routing Context in which this gateway is present. VrfUUID *string `json:"vrf_uuid,omitempty"` }
SeGatewayHeartbeatFailedDetails se gateway heartbeat failed details swagger:model SeGatewayHeartbeatFailedDetails
type SeGatewayHeartbeatSuccessDetails ¶
type SeGatewayHeartbeatSuccessDetails struct { // IP address of gateway monitored. // Required: true GatewayIP *string `json:"gateway_ip"` // Name of Virtual Routing Context in which this gateway is present. VrfName *string `json:"vrf_name,omitempty"` // UUID of the Virtual Routing Context in which this gateway is present. VrfUUID *string `json:"vrf_uuid,omitempty"` }
SeGatewayHeartbeatSuccessDetails se gateway heartbeat success details swagger:model SeGatewayHeartbeatSuccessDetails
type SeGeoDbDetails ¶
type SeGeoDbDetails struct { // Geo Db file name. FileName *string `json:"file_name,omitempty"` // Name of the Gslb Geo Db Profile. GeoDbProfileName *string `json:"geo_db_profile_name,omitempty"` // UUID of the Gslb Geo Db Profile. It is a reference to an object of type GslbGeoDbProfile. GeoDbProfileRef *string `json:"geo_db_profile_ref,omitempty"` // Reason for Gslb Geo Db failure. Enum options - NO_ERROR, FILE_ERROR, FILE_FORMAT_ERROR, FILE_NO_RESOURCES. Reason *string `json:"reason,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` // VIP id. VipID *string `json:"vip_id,omitempty"` // Virtual Service name. It is a reference to an object of type VirtualService. VirtualService *string `json:"virtual_service,omitempty"` }
SeGeoDbDetails se geo db details swagger:model SeGeoDbDetails
type SeGroupAnalyticsPolicy ¶
type SeGroupAnalyticsPolicy struct { // Thresholds for various events generated by metrics system. Field introduced in 20.1.3. MetricsEventThresholds []*MetricsEventThreshold `json:"metrics_event_thresholds,omitempty"` }
SeGroupAnalyticsPolicy se group analytics policy swagger:model SeGroupAnalyticsPolicy
type SeGroupOptions ¶
type SeGroupOptions struct { // The error recovery action configured for a SE Group. Enum options - ROLLBACK_UPGRADE_OPS_ON_ERROR, SUSPEND_UPGRADE_OPS_ON_ERROR, CONTINUE_UPGRADE_OPS_ON_ERROR. Field introduced in 18.2.6. ActionOnError *string `json:"action_on_error,omitempty"` // Disable non-disruptive mechanism. Field introduced in 18.2.6. Disruptive *bool `json:"disruptive,omitempty"` }
SeGroupOptions se group options swagger:model SeGroupOptions
type SeGroupResumeOptions ¶
type SeGroupResumeOptions struct { // The error recovery action configured for a SE Group. Enum options - ROLLBACK_UPGRADE_OPS_ON_ERROR, SUSPEND_UPGRADE_OPS_ON_ERROR, CONTINUE_UPGRADE_OPS_ON_ERROR. Field introduced in 18.2.6. ActionOnError *string `json:"action_on_error,omitempty"` // Allow disruptive mechanism. Field introduced in 18.2.8, 20.1.1. Disruptive *bool `json:"disruptive,omitempty"` // Skip upgrade on suspended SE(s). Field introduced in 18.2.6. SkipSuspended *bool `json:"skip_suspended,omitempty"` }
SeGroupResumeOptions se group resume options swagger:model SeGroupResumeOptions
type SeGroupStatus ¶
type SeGroupStatus struct { // Controller version. Field introduced in 18.2.6. ControllerVersion *string `json:"controller_version,omitempty"` // It is a reference to an object of type VirtualService. DisruptedVsRef []string `json:"disrupted_vs_ref,omitempty"` // duration of SeGroupStatus. Duration *string `json:"duration,omitempty"` // end_time of SeGroupStatus. EndTime *string `json:"end_time,omitempty"` // enqueue_time of SeGroupStatus. EnqueueTime *string `json:"enqueue_time,omitempty"` // Enum options - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY. HaMode *string `json:"ha_mode,omitempty"` // ServiceEngineGroup upgrade in progress. Field introduced in 18.2.6. InProgress *bool `json:"in_progress,omitempty"` // notes of SeGroupStatus. Notes []string `json:"notes,omitempty"` // Number of num_se. NumSe *int32 `json:"num_se,omitempty"` // Number of num_se_with_no_vs. NumSeWithNoVs *int32 `json:"num_se_with_no_vs,omitempty"` // Number of num_se_with_vs_not_scaledout. NumSeWithVsNotScaledout *int32 `json:"num_se_with_vs_not_scaledout,omitempty"` // Number of num_se_with_vs_scaledout. NumSeWithVsScaledout *int32 `json:"num_se_with_vs_scaledout,omitempty"` // Number of num_vs. NumVs *int32 `json:"num_vs,omitempty"` // Number of num_vs_disrupted. NumVsDisrupted *int32 `json:"num_vs_disrupted,omitempty"` // Number of progress. Progress *int32 `json:"progress,omitempty"` // reason of SeGroupStatus. Reason []string `json:"reason,omitempty"` // request_time of SeGroupStatus. RequestTime *string `json:"request_time,omitempty"` // ServiceEngines are already upgraded before the upgrade. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. SeAlreadyUpgradedAtStart []string `json:"se_already_upgraded_at_start,omitempty"` // ServiceEngines in disconnected state before starting the upgrade. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. SeDisconnectedAtStart []string `json:"se_disconnected_at_start,omitempty"` // se_group_name of SeGroupStatus. SeGroupName *string `json:"se_group_name,omitempty"` // Unique object identifier of se_group. SeGroupUUID *string `json:"se_group_uuid,omitempty"` // ServiceEngines local ip not present before the upgrade. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. SeIPMissingAtStart []string `json:"se_ip_missing_at_start,omitempty"` // ServiceEngines in poweredoff state before the upgrade. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. SePoweredoffAtStart []string `json:"se_poweredoff_at_start,omitempty"` // It is a reference to an object of type ServiceEngine. SeRebootInProgressRef *string `json:"se_reboot_in_progress_ref,omitempty"` // ServiceEngines upgrade completed. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. SeUpgradeCompleted []string `json:"se_upgrade_completed,omitempty"` // ServiceEngineGroup upgrade errors. Field introduced in 18.2.6. SeUpgradeErrors []*SeUpgradeEvents `json:"se_upgrade_errors,omitempty"` // ServiceEngines upgrade failed. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. SeUpgradeFailed []string `json:"se_upgrade_failed,omitempty"` // ServiceEngines upgrade in progress. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. SeUpgradeInProgress []string `json:"se_upgrade_in_progress,omitempty"` // ServiceEngines upgrade not started. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. SeUpgradeNotStarted []string `json:"se_upgrade_not_started,omitempty"` // Service Engines that were in suspended state and were skipped upon Service Engine Group ugprade resumption. It is a reference to an object of type ServiceEngine. SeUpgradeSkipSuspended []string `json:"se_upgrade_skip_suspended,omitempty"` // Service Engines which triggered Service Engine Group to be in suspended state. It is a reference to an object of type ServiceEngine. SeUpgradeSuspended []string `json:"se_upgrade_suspended,omitempty"` // It is a reference to an object of type ServiceEngine. SeWithNoVs []string `json:"se_with_no_vs,omitempty"` // It is a reference to an object of type ServiceEngine. SeWithVsNotScaledout []string `json:"se_with_vs_not_scaledout,omitempty"` // It is a reference to an object of type ServiceEngine. SeWithVsScaledout []string `json:"se_with_vs_scaledout,omitempty"` // start_time of SeGroupStatus. StartTime *string `json:"start_time,omitempty"` // Enum options - SE_UPGRADE_PREVIEW. SE_UPGRADE_IN_PROGRESS. SE_UPGRADE_COMPLETE. SE_UPGRADE_ERROR. SE_UPGRADE_PRE_CHECKS. SE_IMAGE_INSTALL. SE_UPGRADE_IMAGE_NOT_FOUND. SE_ALREADY_UPGRADED. SE_REBOOT. SE_CONNECT_AFTER_REBOOT. SE_PRE_UPGRADE_TASKS. SE_POST_UPGRADE_TASKS. SE_WAIT_FOR_SWITCHOVER. SE_CHECK_SCALEDOUT_VS_EXISTS. SE_UPGRADE_SEMGR_REQUEST. SE_UPGRADE_SEMGR_SE_UNREACHABLE. SE_PRE_UPGRADE_SCALE_IN_OPS. SE_POST_UPGRADE_SCALE_OUT_OPS. SE_UPGRADE_SUSPENDED. SE_UPGRADE_START... State *string `json:"state,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // thread of SeGroupStatus. Thread *string `json:"thread,omitempty"` // Enum options - TRAFFIC_DISRUPTED, TRAFFIC_NOT_DISRUPTED. TrafficStatus *string `json:"traffic_status,omitempty"` // VirtualService errors during the SeGroup upgrade. Field introduced in 18.2.6. VsErrors []*VsError `json:"vs_errors,omitempty"` // It is a reference to an object of type VirtualService. VsMigrateInProgressRef []string `json:"vs_migrate_in_progress_ref,omitempty"` // It is a reference to an object of type VirtualService. VsScaleinInProgressRef []string `json:"vs_scalein_in_progress_ref,omitempty"` // It is a reference to an object of type VirtualService. VsScaleoutInProgressRef []string `json:"vs_scaleout_in_progress_ref,omitempty"` // worker of SeGroupStatus. Worker *string `json:"worker,omitempty"` }
SeGroupStatus se group status swagger:model SeGroupStatus
type SeHBEventDetails ¶
type SeHBEventDetails struct { // HB Request/Response not received. HbType *int32 `json:"hb_type,omitempty"` // UUID of the SE with which Heartbeat failed. It is a reference to an object of type ServiceEngine. Field introduced in 20.1.1. RemoteSeRef *string `json:"remote_se_ref,omitempty"` // UUID of the SE reporting this event. It is a reference to an object of type ServiceEngine. Field introduced in 20.1.1. ReportingSeRef *string `json:"reporting_se_ref,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. Field deprecated in 20.1.1. SeRef1 *string `json:"se_ref1,omitempty"` // UUID of a SE in the SE-Group which failed to respond. It is a reference to an object of type ServiceEngine. Field deprecated in 20.1.1. SeRef2 *string `json:"se_ref2,omitempty"` // UUID of the virtual service which is placed on reporting-SE and remote-SE. Field introduced in 20.1.1. VsUUID *string `json:"vs_uuid,omitempty"` }
SeHBEventDetails se h b event details swagger:model SeHBEventDetails
type SeHbRecoveredEventDetails ¶
type SeHbRecoveredEventDetails struct { // Heartbeat Request/Response received. HbType *int32 `json:"hb_type,omitempty"` // UUID of the remote SE with which dataplane heartbeat recovered. It is a reference to an object of type ServiceEngine. Field introduced in 20.1.1. RemoteSeRef *string `json:"remote_se_ref,omitempty"` // UUID of the SE reporting this event. It is a reference to an object of type ServiceEngine. Field introduced in 20.1.1. ReportingSeRef *string `json:"reporting_se_ref,omitempty"` // UUID of a VS which is placed on reporting-SE and remote-SE. Field introduced in 20.1.1. VsUUID *string `json:"vs_uuid,omitempty"` }
SeHbRecoveredEventDetails se hb recovered event details swagger:model SeHbRecoveredEventDetails
type SeHmEventGSDetails ¶
type SeHmEventGSDetails struct { // GslbService name. It is a reference to an object of type GslbService. GslbService *string `json:"gslb_service,omitempty"` // HA Compromised reason. HaReason *string `json:"ha_reason,omitempty"` // Reason Gslb Service is down. Reason *string `json:"reason,omitempty"` // Service Engine name. SeName *string `json:"se_name,omitempty"` // UUID of the event generator. SrcUUID *string `json:"src_uuid,omitempty"` }
SeHmEventGSDetails se hm event g s details swagger:model SeHmEventGSDetails
type SeHmEventGslbPoolDetails ¶
type SeHmEventGslbPoolDetails struct { // GslbService Pool name. Gsgroup *string `json:"gsgroup,omitempty"` // Gslb service name. It is a reference to an object of type GslbService. GslbService *string `json:"gslb_service,omitempty"` // GslbService member details. Gsmember *SeHmEventGslbPoolMemberDetails `json:"gsmember,omitempty"` // HA Compromised reason. HaReason *string `json:"ha_reason,omitempty"` // Service Engine. SeName *string `json:"se_name,omitempty"` // UUID of the event generator. SrcUUID *string `json:"src_uuid,omitempty"` }
SeHmEventGslbPoolDetails se hm event gslb pool details swagger:model SeHmEventGslbPoolDetails
type SeHmEventGslbPoolMemberDetails ¶
type SeHmEventGslbPoolMemberDetails struct { // Placeholder for description of property app_info of obj type SeHmEventGslbPoolMemberDetails field type str type object AppInfo []*AppInfo `json:"app_info,omitempty"` // Domain name used to health monitor this member. Domain *string `json:"domain,omitempty"` // Gslb health monitor failure code. Enum options - ARP_UNRESOLVED, CONNECTION_REFUSED, CONNECTION_TIMEOUT, RESPONSE_CODE_MISMATCH, PAYLOAD_CONTENT_MISMATCH, SERVER_UNREACHABLE, CONNECTION_RESET, CONNECTION_ERROR, HOST_ERROR, ADDRESS_ERROR, NO_PORT, PAYLOAD_TIMEOUT, NO_RESPONSE, NO_RESOURCES, SSL_ERROR, SSL_CERT_ERROR, PORT_UNREACHABLE, SCRIPT_ERROR, OTHER_ERROR, SERVER_DISABLED... FailureCode *string `json:"failure_code,omitempty"` // IP address of GslbService member. // Required: true IP *IPAddr `json:"ip"` // Placeholder for description of property shm of obj type SeHmEventGslbPoolMemberDetails field type str type object Shm []*SeHmEventShmDetails `json:"shm,omitempty"` // Enum options - ADF_CLIENT_CONN_SETUP_REFUSED. ADF_SERVER_CONN_SETUP_REFUSED. ADF_CLIENT_CONN_SETUP_TIMEDOUT. ADF_SERVER_CONN_SETUP_TIMEDOUT. ADF_CLIENT_CONN_SETUP_FAILED_INTERNAL. ADF_SERVER_CONN_SETUP_FAILED_INTERNAL. ADF_CLIENT_CONN_SETUP_FAILED_BAD_PACKET. ADF_UDP_CONN_SETUP_FAILED_INTERNAL. ADF_UDP_SERVER_CONN_SETUP_FAILED_INTERNAL. ADF_CLIENT_SENT_RESET. ADF_SERVER_SENT_RESET. ADF_CLIENT_CONN_TIMEDOUT. ADF_SERVER_CONN_TIMEDOUT. ADF_USER_DELETE_OPERATION. ADF_CLIENT_REQUEST_TIMEOUT. ADF_CLIENT_CONN_ABORTED. ADF_CLIENT_SSL_HANDSHAKE_FAILURE. ADF_CLIENT_CONN_FAILED. ADF_SERVER_CERTIFICATE_VERIFICATION_FAILED. ADF_SERVER_SIDE_SSL_HANDSHAKE_FAILED... SslErrorCode *string `json:"ssl_error_code,omitempty"` }
SeHmEventGslbPoolMemberDetails se hm event gslb pool member details swagger:model SeHmEventGslbPoolMemberDetails
type SeHmEventPoolDetails ¶
type SeHmEventPoolDetails struct { // HA Compromised reason. HaReason *string `json:"ha_reason,omitempty"` // Percentage of servers up. PercentServersUp *string `json:"percent_servers_up,omitempty"` // Pool name. It is a reference to an object of type Pool. Pool *string `json:"pool,omitempty"` // Service Engine. SeName *string `json:"se_name,omitempty"` // Server details. Server *SeHmEventServerDetails `json:"server,omitempty"` // UUID of the event generator. SrcUUID *string `json:"src_uuid,omitempty"` // Virtual service name. It is a reference to an object of type VirtualService. VirtualService *string `json:"virtual_service,omitempty"` }
SeHmEventPoolDetails se hm event pool details swagger:model SeHmEventPoolDetails
type SeHmEventServerDetails ¶
type SeHmEventServerDetails struct { // Placeholder for description of property app_info of obj type SeHmEventServerDetails field type str type object AppInfo []*AppInfo `json:"app_info,omitempty"` // Server description. Description *string `json:"description,omitempty"` // Healthmonitor Failure code. Enum options - ARP_UNRESOLVED, CONNECTION_REFUSED, CONNECTION_TIMEOUT, RESPONSE_CODE_MISMATCH, PAYLOAD_CONTENT_MISMATCH, SERVER_UNREACHABLE, CONNECTION_RESET, CONNECTION_ERROR, HOST_ERROR, ADDRESS_ERROR, NO_PORT, PAYLOAD_TIMEOUT, NO_RESPONSE, NO_RESOURCES, SSL_ERROR, SSL_CERT_ERROR, PORT_UNREACHABLE, SCRIPT_ERROR, OTHER_ERROR, SERVER_DISABLED... FailureCode *string `json:"failure_code,omitempty"` // Host name or VM name or DNS name for the server. Hostname *string `json:"hostname,omitempty"` // IP address of server. // Required: true IP *IPAddr `json:"ip"` // Port override form the pool port. If server port is not specified, the pool port is used. Port *int32 `json:"port,omitempty"` // Placeholder for description of property shm of obj type SeHmEventServerDetails field type str type object Shm []*SeHmEventShmDetails `json:"shm,omitempty"` // Enum options - ADF_CLIENT_CONN_SETUP_REFUSED. ADF_SERVER_CONN_SETUP_REFUSED. ADF_CLIENT_CONN_SETUP_TIMEDOUT. ADF_SERVER_CONN_SETUP_TIMEDOUT. ADF_CLIENT_CONN_SETUP_FAILED_INTERNAL. ADF_SERVER_CONN_SETUP_FAILED_INTERNAL. ADF_CLIENT_CONN_SETUP_FAILED_BAD_PACKET. ADF_UDP_CONN_SETUP_FAILED_INTERNAL. ADF_UDP_SERVER_CONN_SETUP_FAILED_INTERNAL. ADF_CLIENT_SENT_RESET. ADF_SERVER_SENT_RESET. ADF_CLIENT_CONN_TIMEDOUT. ADF_SERVER_CONN_TIMEDOUT. ADF_USER_DELETE_OPERATION. ADF_CLIENT_REQUEST_TIMEOUT. ADF_CLIENT_CONN_ABORTED. ADF_CLIENT_SSL_HANDSHAKE_FAILURE. ADF_CLIENT_CONN_FAILED. ADF_SERVER_CERTIFICATE_VERIFICATION_FAILED. ADF_SERVER_SIDE_SSL_HANDSHAKE_FAILED... SslErrorCode *string `json:"ssl_error_code,omitempty"` }
SeHmEventServerDetails se hm event server details swagger:model SeHmEventServerDetails
type SeHmEventShmDetails ¶
type SeHmEventShmDetails struct { // Average health monitor response time from server in milli-seconds. AverageResponseTime *int64 `json:"average_response_time,omitempty"` // Health Monitor name. It is a reference to an object of type HealthMonitor. // Required: true HealthMonitor *string `json:"health_monitor"` // resp_string of SeHmEventShmDetails. RespString *string `json:"resp_string,omitempty"` // Response code from server. Field introduced in 17.2.4. ResponseCode *int32 `json:"response_code,omitempty"` }
SeHmEventShmDetails se hm event shm details swagger:model SeHmEventShmDetails
type SeHmEventVsDetails ¶
type SeHmEventVsDetails struct { // HA Compromised reason. HaReason *string `json:"ha_reason,omitempty"` // Reason for Virtual Service Down. Reason *string `json:"reason,omitempty"` // Service Engine name. SeName *string `json:"se_name,omitempty"` // UUID of the event generator. SrcUUID *string `json:"src_uuid,omitempty"` // VIP address. Vip6Address *IPAddr `json:"vip6_address,omitempty"` // VIP address. VipAddress *IPAddr `json:"vip_address,omitempty"` // VIP id. VipID *string `json:"vip_id,omitempty"` // Virtual Service name. It is a reference to an object of type VirtualService. VirtualService *string `json:"virtual_service,omitempty"` }
SeHmEventVsDetails se hm event vs details swagger:model SeHmEventVsDetails
type SeIPAddedEventDetails ¶
type SeIPAddedEventDetails struct { // Vnic name. IfName *string `json:"if_name,omitempty"` // IP added. IP *string `json:"ip,omitempty"` // Vnic linux name. LinuxName *string `json:"linux_name,omitempty"` // Mac Address. Mac *string `json:"mac,omitempty"` // Mask . Mask *int32 `json:"mask,omitempty"` // DCHP or Static. Mode *string `json:"mode,omitempty"` // Network UUID. NetworkUUID *string `json:"network_uuid,omitempty"` // Namespace. Ns *string `json:"ns,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` }
SeIPAddedEventDetails se Ip added event details swagger:model SeIpAddedEventDetails
type SeIPRemovedEventDetails ¶
type SeIPRemovedEventDetails struct { // Vnic name. IfName *string `json:"if_name,omitempty"` // IP added. IP *string `json:"ip,omitempty"` // Vnic linux name. LinuxName *string `json:"linux_name,omitempty"` // Mac Address. Mac *string `json:"mac,omitempty"` // Mask . Mask *int32 `json:"mask,omitempty"` // DCHP or Static. Mode *string `json:"mode,omitempty"` // Network UUID. NetworkUUID *string `json:"network_uuid,omitempty"` // Namespace. Ns *string `json:"ns,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` }
SeIPRemovedEventDetails se Ip removed event details swagger:model SeIpRemovedEventDetails
type SeIp6DadFailedEventDetails ¶
type SeIp6DadFailedEventDetails struct { // IPv6 address. DadIP *IPAddr `json:"dad_ip,omitempty"` // Vnic name. IfName *string `json:"if_name,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` }
SeIp6DadFailedEventDetails se ip6 dad failed event details swagger:model SeIP6DadFailedEventDetails
type SeIpfailureEventDetails ¶
type SeIpfailureEventDetails struct { // Mac Address. Mac *string `json:"mac,omitempty"` // Network UUID. NetworkUUID *string `json:"network_uuid,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` // Vnic name. VnicName *string `json:"vnic_name,omitempty"` }
SeIpfailureEventDetails se ipfailure event details swagger:model SeIpfailureEventDetails
type SeLicensedBandwdithExceededEventDetails ¶
type SeLicensedBandwdithExceededEventDetails struct { // Number of packets dropped since the last event. NumPktsDropped *int32 `json:"num_pkts_dropped,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` }
SeLicensedBandwdithExceededEventDetails se licensed bandwdith exceeded event details swagger:model SeLicensedBandwdithExceededEventDetails
type SeList ¶
type SeList struct { // This flag is set when scaling in an SE in admin down mode. AdminDownRequested *bool `json:"admin_down_requested,omitempty"` // Indicates if an SE is at the current version. This state will now be derived from SE Group runtime. Field deprecated in 18.1.5, 18.2.1. AtCurrVer *bool `json:"at_curr_ver,omitempty"` // This field indicates the status of programming network reachability to the Virtual Service IP in the cloud. Field introduced in 17.2.3. AttachIPStatus *string `json:"attach_ip_status,omitempty"` // This flag indicates if network reachability to the Virtual Service IP in the cloud has been successfully programmed. Field introduced in 17.2.3. AttachIPSuccess *bool `json:"attach_ip_success,omitempty"` // This flag is set when an SE is admin down or scaling in. DeleteInProgress *bool `json:"delete_in_progress,omitempty"` // This field is not needed with the current implementation of Update RPCs to SEs. Field deprecated in 18.1.5, 18.2.1. DownloadSelistOnly *bool `json:"download_selist_only,omitempty"` // Placeholder for description of property floating_intf_ip of obj type SeList field type str type object FloatingIntfIP []*IPAddr `json:"floating_intf_ip,omitempty"` // This flag indicates whether the geo-files have been pushed to the DNS-VS's SE. No longer used, replaced by SE DataStore. Field deprecated in 18.1.5, 18.2.1. Field introduced in 17.1.1. GeoDownload *bool `json:"geo_download,omitempty"` // This flag indicates whether the geodb object has been pushed to the DNS-VS's SE. No longer used, replaced by SE DataStore. Field deprecated in 18.1.5, 18.2.1. Field introduced in 17.1.2. GeodbDownload *bool `json:"geodb_download,omitempty"` // This flag indicates whether the gslb, ghm, gs objects have been pushed to the DNS-VS's SE. No longer used, replaced by SE DataStore. Field deprecated in 18.1.5, 18.2.1. Field introduced in 17.1.1. GslbDownload *bool `json:"gslb_download,omitempty"` // Updated whenever this entry is created. When the sees this has changed, it means that the SE should disrupt, since there was a delete then create, not an update. Field introduced in 18.1.5,18.2.1. Incarnation *string `json:"incarnation,omitempty"` // This flag was used to display the SE connected state. This state will now be derived from SE Group runtime. Field deprecated in 18.1.5, 18.2.1. IsConnected *bool `json:"is_connected,omitempty"` // Placeholder for description of property is_portchannel of obj type SeList field type str type boolean IsPortchannel *bool `json:"is_portchannel,omitempty"` // Placeholder for description of property is_primary of obj type SeList field type str type boolean IsPrimary *bool `json:"is_primary,omitempty"` // Placeholder for description of property is_standby of obj type SeList field type str type boolean IsStandby *bool `json:"is_standby,omitempty"` // Number of memory. Memory *int32 `json:"memory,omitempty"` // Management IPv4 address of SE. Field introduced in 20.1.3. MgmtIP *IPAddr `json:"mgmt_ip,omitempty"` // Management IPv6 address of SE. Field introduced in 20.1.3. MgmtIp6 *IPAddr `json:"mgmt_ip6,omitempty"` // This field is not needed with the current implementation of Update RPCs to SEs. Field deprecated in 18.1.5, 18.2.1. PendingDownload *bool `json:"pending_download,omitempty"` // SE scaling in status is determined by delete_in_progress. Field deprecated in 18.1.5, 18.2.1. ScaleinInProgress *bool `json:"scalein_in_progress,omitempty"` // This flag is set when a VS is actively scaling out to this SE. Field introduced in 18.1.5, 18.2.1. ScaleoutInProgress *bool `json:"scaleout_in_progress,omitempty"` // It is a reference to an object of type ServiceEngine. // Required: true SeRef *string `json:"se_ref"` // Number of sec_idx. SecIdx *int32 `json:"sec_idx,omitempty"` // Placeholder for description of property snat_ip of obj type SeList field type str type object SnatIP *IPAddr `json:"snat_ip,omitempty"` // Number of vcpus. Vcpus *int32 `json:"vcpus,omitempty"` // Version of the SE. This state will now be derived from SE Group runtime. Field deprecated in 18.1.5, 18.2.1. Version *string `json:"version,omitempty"` // Field introduced in 18.1.1. Vip6SubnetMask *int32 `json:"vip6_subnet_mask,omitempty"` // Placeholder for description of property vip_intf_ip of obj type SeList field type str type object VipIntfIP *IPAddr `json:"vip_intf_ip,omitempty"` // Placeholder for description of property vip_intf_list of obj type SeList field type str type object VipIntfList []*SeVipInterfaceList `json:"vip_intf_list,omitempty"` // vip_intf_mac of SeList. VipIntfMac *string `json:"vip_intf_mac,omitempty"` // Number of vip_subnet_mask. VipSubnetMask *int32 `json:"vip_subnet_mask,omitempty"` // Number of vlan_id. VlanID *int32 `json:"vlan_id,omitempty"` // Placeholder for description of property vnic of obj type SeList field type str type object Vnic []*VsSeVnic `json:"vnic,omitempty"` }
SeList se list swagger:model SeList
type SeMemoryLimitEventDetails ¶
type SeMemoryLimitEventDetails struct { // Current status of config memory. Field introduced in 18.2.2. ConfigMemoryStatus *string `json:"config_memory_status,omitempty"` // Heap config memory hard limit. Field introduced in 18.2.2. HeapConfigHardLimit *int32 `json:"heap_config_hard_limit,omitempty"` // Heap config memory soft limit. Field introduced in 18.2.2. HeapConfigSoftLimit *int32 `json:"heap_config_soft_limit,omitempty"` // Config memory usage in heap memory. Field introduced in 18.2.2. HeapConfigUsage *int32 `json:"heap_config_usage,omitempty"` // Connection memory usage in heap memory. Field introduced in 18.2.2. HeapConnUsage *int32 `json:"heap_conn_usage,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.2. SeRef *string `json:"se_ref,omitempty"` // Current shm config memory hard limit. Field introduced in 18.2.2. ShmConfigHardLimit *int32 `json:"shm_config_hard_limit,omitempty"` // Current shm config memory soft limit. Field introduced in 18.2.2. ShmConfigSoftLimit *int32 `json:"shm_config_soft_limit,omitempty"` // Config memory usage in shared memory. Field introduced in 18.2.2. ShmConfigUsage *int32 `json:"shm_config_usage,omitempty"` // Connection memory usage in shared memory. Field introduced in 18.2.2. ShmConnUsage *int32 `json:"shm_conn_usage,omitempty"` }
SeMemoryLimitEventDetails se memory limit event details swagger:model SeMemoryLimitEventDetails
type SeMgrDebugFilter ¶
type SeMgrDebugFilter struct { // Name of the object. Name *string `json:"name,omitempty"` }
SeMgrDebugFilter se mgr debug filter swagger:model SeMgrDebugFilter
type SeMgrEventDetails ¶
type SeMgrEventDetails struct { // cloud_name of SeMgrEventDetails. CloudName *string `json:"cloud_name,omitempty"` // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` // enable_state of SeMgrEventDetails. EnableState *string `json:"enable_state,omitempty"` // Placeholder for description of property gcp_info of obj type SeMgrEventDetails field type str type object GcpInfo *GcpInfo `json:"gcp_info,omitempty"` // host_name of SeMgrEventDetails. HostName *string `json:"host_name,omitempty"` // Unique object identifier of host. HostUUID *string `json:"host_uuid,omitempty"` // Number of memory. Memory *int32 `json:"memory,omitempty"` // migrate_state of SeMgrEventDetails. MigrateState *string `json:"migrate_state,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Field introduced in 20.1.3. NewMgmtIP *string `json:"new_mgmt_ip,omitempty"` // Field introduced in 20.1.3. NewMgmtIp6 *string `json:"new_mgmt_ip6,omitempty"` // Field introduced in 20.1.3. OldMgmtIP *string `json:"old_mgmt_ip,omitempty"` // Field introduced in 20.1.3. OldMgmtIp6 *string `json:"old_mgmt_ip6,omitempty"` // reason of SeMgrEventDetails. Reason *string `json:"reason,omitempty"` // se_grp_name of SeMgrEventDetails. SeGrpName *string `json:"se_grp_name,omitempty"` // Unique object identifier of se_grp. SeGrpUUID *string `json:"se_grp_uuid,omitempty"` // Number of vcpus. Vcpus *int32 `json:"vcpus,omitempty"` // vs_name of SeMgrEventDetails. VsName []string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID []string `json:"vs_uuid,omitempty"` }
SeMgrEventDetails se mgr event details swagger:model SeMgrEventDetails
type SeMigrateEventDetails ¶
type SeMigrateEventDetails struct { // Number of num_vs. NumVs *int32 `json:"num_vs,omitempty"` // reason of SeMigrateEventDetails. Reason []string `json:"reason,omitempty"` // se_name of SeMigrateEventDetails. SeName *string `json:"se_name,omitempty"` // Unique object identifier of se. // Required: true SeUUID *string `json:"se_uuid"` // vs_name of SeMigrateEventDetails. VsName *string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID *string `json:"vs_uuid,omitempty"` }
SeMigrateEventDetails se migrate event details swagger:model SeMigrateEventDetails
type SePersistenceEventDetails ¶
type SePersistenceEventDetails struct { // Current number of entries in the client ip persistence table. Entries *int32 `json:"entries,omitempty"` // Name of pool whose persistence table limits were reached. It is a reference to an object of type Pool. Pool *string `json:"pool,omitempty"` // Type of persistence. Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE. Type *string `json:"type,omitempty"` }
SePersistenceEventDetails se persistence event details swagger:model SePersistenceEventDetails
type SePoolLbEventDetails ¶
type SePoolLbEventDetails struct { // Reason code for load balancing failure. Enum options - PERSISTENT_SERVER_INVALID, PERSISTENT_SERVER_DOWN, SRVR_DOWN, ADD_PENDING, SLOW_START_MAX_CONN, MAX_CONN, NO_LPORT, SUSPECT_STATE, MAX_CONN_RATE, CAPEST_RAND_MAX_CONN, GET_NEXT. FailureCode *string `json:"failure_code,omitempty"` // Pool name. It is a reference to an object of type Pool. Pool *string `json:"pool,omitempty"` // Reason for Load balancing failure. Reason *string `json:"reason,omitempty"` // UUID of event generator. SrcUUID *string `json:"src_uuid,omitempty"` // Virtual Service name. It is a reference to an object of type VirtualService. VirtualService *string `json:"virtual_service,omitempty"` }
SePoolLbEventDetails se pool lb event details swagger:model SePoolLbEventDetails
type SeProperties ¶
type SeProperties struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Placeholder for description of property se_agent_properties of obj type SeProperties field type str type object SeAgentProperties *SeAgentProperties `json:"se_agent_properties,omitempty"` // Placeholder for description of property se_bootup_properties of obj type SeProperties field type str type object SeBootupProperties *SeBootupProperties `json:"se_bootup_properties,omitempty"` // Placeholder for description of property se_runtime_properties of obj type SeProperties field type str type object SeRuntimeProperties *SeRuntimeProperties `json:"se_runtime_properties,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
SeProperties se properties swagger:model SeProperties
type SePropertiesAPIResponse ¶
type SePropertiesAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SeProperties `json:"results,omitempty"` }
SePropertiesAPIResponse se properties Api response swagger:model SePropertiesApiResponse
type SeRPCProxyDebugFilter ¶
type SeRPCProxyDebugFilter struct { // Method name of RPC. Field introduced in 18.1.5, 18.2.1. MethodName *string `json:"method_name,omitempty"` // Queue name of RPC. Field introduced in 18.1.5, 18.2.1. Queue *string `json:"queue,omitempty"` // UUID of Service Engine. Field introduced in 18.1.5, 18.2.1. SeUUID *string `json:"se_uuid,omitempty"` }
SeRPCProxyDebugFilter se Rpc proxy debug filter swagger:model SeRpcProxyDebugFilter
type SeRateLimiters ¶
type SeRateLimiters struct { // Rate limiter for ARP packets in pps. ArpRl *int32 `json:"arp_rl,omitempty"` // Default Rate limiter in pps. DefaultRl *int32 `json:"default_rl,omitempty"` // Rate limiter for number of flow probes in pps. FlowProbeRl *int32 `json:"flow_probe_rl,omitempty"` // Rate limiter for ICMP requests in pps. IcmpRl *int32 `json:"icmp_rl,omitempty"` // Rate limiter for ICMP response in pps. IcmpRspRl *int32 `json:"icmp_rsp_rl,omitempty"` // Rate limiter for number RST pkts sent in pps. RstRl *int32 `json:"rst_rl,omitempty"` }
SeRateLimiters se rate limiters swagger:model SeRateLimiters
type SeReconcileDetails ¶
type SeReconcileDetails struct { // Placeholder for description of property new_service_cores of obj type SeReconcileDetails field type str type number NewServiceCores *float64 `json:"new_service_cores,omitempty"` // Placeholder for description of property old_service_cores of obj type SeReconcileDetails field type str type number OldServiceCores *float64 `json:"old_service_cores,omitempty"` // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` // Unique object identifier of tenant. TenantUUID *string `json:"tenant_uuid,omitempty"` // tier of SeReconcileDetails. Tier *string `json:"tier,omitempty"` }
SeReconcileDetails se reconcile details swagger:model SeReconcileDetails
type SeResources ¶
type SeResources struct { // Number of cores_per_socket. CoresPerSocket *int32 `json:"cores_per_socket,omitempty"` // Number of disk. // Required: true Disk *int32 `json:"disk"` // Placeholder for description of property hyper_threading of obj type SeResources field type str type boolean HyperThreading *bool `json:"hyper_threading,omitempty"` // Indicates that the SE is running on a Virtual Machine. Field introduced in 20.1.1. HypervisorMode *bool `json:"hypervisor_mode,omitempty"` // Number of memory. // Required: true Memory *int32 `json:"memory"` // Indicates the number of datapath processes spawned. Field introduced in 20.1.1. NumDatapathProcesses *int32 `json:"num_datapath_processes,omitempty"` // Number of num_vcpus. // Required: true NumVcpus *int32 `json:"num_vcpus"` // Number of sockets. Sockets *int32 `json:"sockets,omitempty"` }
SeResources se resources swagger:model SeResources
type SeRuntimeCompressionProperties ¶
type SeRuntimeCompressionProperties struct { // If client RTT is higher than this threshold, enable normal compression on the response. Unit is MILLISECONDS. MaxLowRtt *int32 `json:"max_low_rtt,omitempty"` // If client RTT is higher than this threshold, enable aggressive compression on the response. Unit is MILLISECONDS. MinHighRtt *int32 `json:"min_high_rtt,omitempty"` // Minimum response content length to enable compression. MinLength *int32 `json:"min_length,omitempty"` // Values that identify mobile browsers in order to enable aggressive compression. MobileStr []string `json:"mobile_str,omitempty"` }
SeRuntimeCompressionProperties se runtime compression properties swagger:model SeRuntimeCompressionProperties
type SeRuntimeProperties ¶
type SeRuntimeProperties struct { // Allow admin user ssh access to SE. Field introduced in 18.2.5. AdminSSHEnabled *bool `json:"admin_ssh_enabled,omitempty"` // Placeholder for description of property app_headers of obj type SeRuntimeProperties field type str type object AppHeaders []*AppHdr `json:"app_headers,omitempty"` // Control if dispatcher core also handles TCP flows in baremetal SE. BaremetalDispatcherHandlesFlows *bool `json:"baremetal_dispatcher_handles_flows,omitempty"` // Rate limit on maximum adf lossy log to pushper second. Allowed in Basic(Allowed values- 1000) edition, Essentials(Allowed values- 1000) edition, Enterprise edition. ConnectionsLossyLogRateLimiterThreshold *int32 `json:"connections_lossy_log_rate_limiter_threshold,omitempty"` // Rate limit on maximum adf udf or nf log to pushper second. Allowed in Basic(Allowed values- 1000) edition, Essentials(Allowed values- 1000) edition, Enterprise edition. ConnectionsUdfnfLogRateLimiterThreshold *int32 `json:"connections_udfnf_log_rate_limiter_threshold,omitempty"` // Disable Flow Probes for Scaled out VS'es. (This field has been moved to se_group properties 20.1.3 onwards.). Field introduced in 17.1.1. DisableFlowProbes *bool `json:"disable_flow_probes,omitempty"` // Deprecated. Field deprecated in 17.2.5. Field introduced in 17.2.1. DisableGro *bool `json:"disable_gro,omitempty"` // Deprecated. Field deprecated in 17.2.5. Field introduced in 17.2.4. DisableTso *bool `json:"disable_tso,omitempty"` // Placeholder for description of property dos_profile of obj type SeRuntimeProperties field type str type object DosProfile *DosThresholdProfile `json:"dos_profile,omitempty"` // Timeout for downstream to become writable. Unit is MILLISECONDS. DownstreamSendTimeout *int32 `json:"downstream_send_timeout,omitempty"` // Frequency of SE - SE HB messages when aggressive failure mode detection is enabled. (This field has been moved to se_group properties 20.1.3 onwards). Unit is MILLISECONDS. Allowed in Basic(Allowed values- 100) edition, Essentials(Allowed values- 100) edition, Enterprise edition. DpAggressiveHbFrequency *int32 `json:"dp_aggressive_hb_frequency,omitempty"` // Consecutive HB failures after which failure is reported to controller,when aggressive failure mode detection is enabled. (This field has been moved to se_group properties 20.1.3 onwards). Allowed in Basic(Allowed values- 10) edition, Essentials(Allowed values- 10) edition, Enterprise edition. DpAggressiveHbTimeoutCount *int32 `json:"dp_aggressive_hb_timeout_count,omitempty"` // Frequency of SE - SE HB messages when aggressive failure mode detection is not enabled. (This field has been moved to se_group properties 20.1.3 onwards). Unit is MILLISECONDS. DpHbFrequency *int32 `json:"dp_hb_frequency,omitempty"` // Consecutive HB failures after which failure is reported to controller, when aggressive failure mode detection is not enabled. (This field has been moved to se_group properties 20.1.3 onwards). DpHbTimeoutCount *int32 `json:"dp_hb_timeout_count,omitempty"` // Frequency of ARP requests sent by SE for each VIP to detect duplicate IP when it loses conectivity to controller. Unit is MILLISECONDS. DupipFrequency *int32 `json:"dupip_frequency,omitempty"` // Number of ARP responses received for the VIP after which SE decides that the VIP has been moved and disables the VIP. DupipTimeoutCount *int32 `json:"dupip_timeout_count,omitempty"` // Enable HSM luna engine logs. Field introduced in 16.4.8, 17.1.11, 17.2.3. EnableHsmLog *bool `json:"enable_hsm_log,omitempty"` // Enable proxy ARP from Host interface for Front End proxies. FeproxyVipsEnableProxyArp *bool `json:"feproxy_vips_enable_proxy_arp,omitempty"` // How often to push the flow table IPC messages in the main loop. The value is the number of times through the loop before pushing the batch. i.e, a value of 1 means every time through the loop. FlowTableBatchPushFrequency *int32 `json:"flow_table_batch_push_frequency,omitempty"` // Deprecated. Field deprecated in 17.1.1. FlowTableMaxEntriesDeprecated *int32 `json:"flow_table_max_entries_deprecated,omitempty"` // Deprecated. Field deprecated in 17.2.5. FlowTableNewSynMaxEntries *int32 `json:"flow_table_new_syn_max_entries,omitempty"` // Overrides the MTU value received via DHCP or some other means. Use this when the infrastructure advertises an MTU that is not supported by all devices in the network. For example, in AWS or when an overlay is used. GlobalMtu *int32 `json:"global_mtu,omitempty"` // Enable Javascript console logs on the client browser when collecting client insights. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. HTTPRumConsoleLog *bool `json:"http_rum_console_log,omitempty"` // Minimum response size content length to sample for client insights. Allowed in Basic(Allowed values- 64) edition, Essentials(Allowed values- 64) edition, Enterprise edition. HTTPRumMinContentLength *int32 `json:"http_rum_min_content_length,omitempty"` // How often to push the LB IPC messages in the main loop. The value is the number of times the loop has to run before pushing the batch. i.e, a value of 1 means the batch is pushed every time the loop runs. Field deprecated in 18.1.3. Field introduced in 17.2.8. LbBatchPushFrequency *int32 `json:"lb_batch_push_frequency,omitempty"` // Deprecated. Field deprecated in 17.1.1. Unit is SEC. LbFailMaxTime *int32 `json:"lb_fail_max_time,omitempty"` // Number of requests to dispatch from the request queue at a regular interval. LbactionNumRequestsToDispatch *int32 `json:"lbaction_num_requests_to_dispatch,omitempty"` // Maximum retries per request in the request queue. LbactionRqPerRequestMaxRetries *int32 `json:"lbaction_rq_per_request_max_retries,omitempty"` // Flag to indicate if log files are compressed upon full on the Service Engine. LogAgentCompressLogs *bool `json:"log_agent_compress_logs,omitempty"` // Log-agent test property used to simulate slow TCP connections. Unit is BYTES. LogAgentConnSendBufferSize *int32 `json:"log_agent_conn_send_buffer_size,omitempty"` // Maximum size of data sent by log-agent to Controller over the TCP connection. Unit is BYTES. LogAgentExportMsgBufferSize *int32 `json:"log_agent_export_msg_buffer_size,omitempty"` // Time log-agent waits before sending data to the Controller. Unit is MILLISECONDS. LogAgentExportWaitTime *int32 `json:"log_agent_export_wait_time,omitempty"` // Maximum application log file size before rollover. LogAgentFileSzAppl *int32 `json:"log_agent_file_sz_appl,omitempty"` // Maximum connection log file size before rollover. LogAgentFileSzConn *int32 `json:"log_agent_file_sz_conn,omitempty"` // Maximum debug log file size before rollover. LogAgentFileSzDebug *int32 `json:"log_agent_file_sz_debug,omitempty"` // Maximum event log file size before rollover. LogAgentFileSzEvent *int32 `json:"log_agent_file_sz_event,omitempty"` // Minimum storage allocated for logs irrespective of memory and cores. Unit is MB. LogAgentLogStorageMinSz *int32 `json:"log_agent_log_storage_min_sz,omitempty"` // Maximum number of Virtual Service log files maintained for significant logs on the Service Engine. LogAgentMaxActiveAdfFilesPerVs *int32 `json:"log_agent_max_active_adf_files_per_vs,omitempty"` // Maximum concurrent rsync requests initiated from log-agent to the Controller. LogAgentMaxConcurrentRsync *int32 `json:"log_agent_max_concurrent_rsync,omitempty"` // Maximum size of serialized log message on the Service Engine. LogAgentMaxLogmessageProtoSz *int32 `json:"log_agent_max_logmessage_proto_sz,omitempty"` // Excess percentage threshold of disk size to trigger cleanup of logs on the Service Engine. LogAgentMaxStorageExcessPercent *int32 `json:"log_agent_max_storage_excess_percent,omitempty"` // Maximum storage on the disk not allocated for logs on the Service Engine. LogAgentMaxStorageIgnorePercent *float32 `json:"log_agent_max_storage_ignore_percent,omitempty"` // Minimum storage allocated to any given VirtualService on the Service Engine. LogAgentMinStoragePerVs *int32 `json:"log_agent_min_storage_per_vs,omitempty"` // Time interval log-agent pauses between logs obtained from the dataplane. Unit is MILLISECONDS. LogAgentPauseInterval *int32 `json:"log_agent_pause_interval,omitempty"` // Internal timer to stall log-agent and prevent it from hogging CPU cycles on the Service Engine. Unit is MILLISECONDS. LogAgentSleepInterval *int32 `json:"log_agent_sleep_interval,omitempty"` // Timeout to purge unknown Virtual Service logs from the Service Engine. Unit is SEC. LogAgentUnknownVsTimer *int32 `json:"log_agent_unknown_vs_timer,omitempty"` // Maximum number of file names in a log message. LogMessageMaxFileListSize *int32 `json:"log_message_max_file_list_size,omitempty"` // Deprecated. Field deprecated in 17.1.1. Unit is MBPS. MaxThroughput *int32 `json:"max_throughput,omitempty"` // enables mcache - controls fetch/store/store_out. McacheEnabled *bool `json:"mcache_enabled,omitempty"` // enables mcache_fetch. McacheFetchEnabled *bool `json:"mcache_fetch_enabled,omitempty"` // Use SE Group's app_cache_percent to set cache memory usage limit on SE. Field deprecated in 18.2.3. McacheMaxCacheSize *int64 `json:"mcache_max_cache_size,omitempty"` // enables mcache_store. McacheStoreInEnabled *bool `json:"mcache_store_in_enabled,omitempty"` // max object size. McacheStoreInMaxSize *int32 `json:"mcache_store_in_max_size,omitempty"` // min object size. McacheStoreInMinSize *int32 `json:"mcache_store_in_min_size,omitempty"` // enables mcache_store_out. McacheStoreOutEnabled *bool `json:"mcache_store_out_enabled,omitempty"` // Use SE Group's app_cache_percent to set cache memory usage limit on SE. Field deprecated in 18.2.3. McacheStoreSeMaxSize *int64 `json:"mcache_store_se_max_size,omitempty"` // Placeholder for description of property ngx_free_connection_stack of obj type SeRuntimeProperties field type str type boolean NgxFreeConnectionStack *bool `json:"ngx_free_connection_stack,omitempty"` // Deprecated. Field deprecated in 17.1.1. PersistenceEntriesLowWatermark *int32 `json:"persistence_entries_low_watermark,omitempty"` // Maximum memory in bytes allocated for persistence entries. Allowed values are 0-33554432. PersistenceMemMax *int32 `json:"persistence_mem_max,omitempty"` // Enable punting of UDP packets from primary to other Service Engines. This applies to Virtual Services with Per-Packet Loadbalancing enabled. ScaleoutUDPPerPkt *bool `json:"scaleout_udp_per_pkt,omitempty"` // LDAP basicauth default bind timeout enforced on connections to LDAP server. Unit is MILLISECONDS. SeAuthLdapBindTimeout *int32 `json:"se_auth_ldap_bind_timeout,omitempty"` // Size of LDAP basicauth credentials cache used on the dataplane. Unit is BYTES. SeAuthLdapCacheSize *int32 `json:"se_auth_ldap_cache_size,omitempty"` // LDAP basicauth default connection timeout enforced on connections to LDAP server. Unit is MILLISECONDS. SeAuthLdapConnectTimeout *int32 `json:"se_auth_ldap_connect_timeout,omitempty"` // Number of concurrent connections to LDAP server by a single basic auth LDAP process. SeAuthLdapConnsPerServer *int32 `json:"se_auth_ldap_conns_per_server,omitempty"` // LDAP basicauth default reconnect timeout enforced on connections to LDAP server. Unit is MILLISECONDS. SeAuthLdapReconnectTimeout *int32 `json:"se_auth_ldap_reconnect_timeout,omitempty"` // LDAP basicauth default login or group search request timeout enforced on connections to LDAP server. Unit is MILLISECONDS. SeAuthLdapRequestTimeout *int32 `json:"se_auth_ldap_request_timeout,omitempty"` // LDAP basicauth uses multiple ldap servers in the event of a failover only. SeAuthLdapServersFailoverOnly *bool `json:"se_auth_ldap_servers_failover_only,omitempty"` // Placeholder for description of property se_dp_compression of obj type SeRuntimeProperties field type str type object SeDpCompression *SeRuntimeCompressionProperties `json:"se_dp_compression,omitempty"` // Deprecated - This field has been moved to se_group properties 20.1.3 onwards. Internal only. Used to simulate SE - SE HB failure. SeDpHmDrops *int32 `json:"se_dp_hm_drops,omitempty"` // Number of jiffies between polling interface state. SeDpIfStatePollInterval *int32 `json:"se_dp_if_state_poll_interval,omitempty"` // Internal buffer full indicator on the Service Engine beyond which the unfiltered logs are abandoned. SeDpLogNfEnqueuePercent *int32 `json:"se_dp_log_nf_enqueue_percent,omitempty"` // Internal buffer full indicator on the Service Engine beyond which the user filtered logs are abandoned. SeDpLogUdfEnqueuePercent *int32 `json:"se_dp_log_udf_enqueue_percent,omitempty"` // Deprecated. Field deprecated in 18.2.5. Field introduced in 17.1.1. SeDpVnicQueueStallEventSleep *int32 `json:"se_dp_vnic_queue_stall_event_sleep,omitempty"` // Deprecated. Field deprecated in 18.2.5. Field introduced in 17.1.1. SeDpVnicQueueStallThreshold *int32 `json:"se_dp_vnic_queue_stall_threshold,omitempty"` // Deprecated. Field deprecated in 18.2.5. Field introduced in 17.1.1. SeDpVnicQueueStallTimeout *int32 `json:"se_dp_vnic_queue_stall_timeout,omitempty"` // Deprecated. Field deprecated in 18.2.5. Field introduced in 17.1.14, 17.2.5, 18.1.1. SeDpVnicRestartOnQueueStallCount *int32 `json:"se_dp_vnic_restart_on_queue_stall_count,omitempty"` // Deprecated. Field deprecated in 18.2.5. Field introduced in 17.1.14, 17.2.5, 18.1.1. SeDpVnicStallSeRestartWindow *int32 `json:"se_dp_vnic_stall_se_restart_window,omitempty"` // Enable core dump on assert. Field introduced in 18.1.3, 18.2.1. SeDumpCoreOnAssert *bool `json:"se_dump_core_on_assert,omitempty"` // Accept/ignore interface routes (i.e, no next hop IP address). SeHandleInterfaceRoutes *bool `json:"se_handle_interface_routes,omitempty"` // Internal use only. Allowed values are 0-7. SeHbPersistFudgeBits *int32 `json:"se_hb_persist_fudge_bits,omitempty"` // Number of packets with wrong mac after which SE attempts to disable promiscious mode. SeMacErrorThresholdToDisablePromiscious *int32 `json:"se_mac_error_threshold_to_disable_promiscious,omitempty"` // Deprecated. Field deprecated in 17.1.1. SeMallocThresh *int32 `json:"se_malloc_thresh,omitempty"` // Internal use only. Enables poisoning of freed memory blocks. SeMemoryPoison *bool `json:"se_memory_poison,omitempty"` // Internal use only. Frequency (ms) of metrics updates from SE to controller. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 60000) edition, Essentials(Allowed values- 60000) edition, Enterprise edition. SeMetricsInterval *int32 `json:"se_metrics_interval,omitempty"` // Internal use only. Enable or disable real time metrics irrespective of virtualservice or SE group configuration. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. SeMetricsRtEnabled *bool `json:"se_metrics_rt_enabled,omitempty"` // Internal use only. Frequency (ms) of realtime metrics updates from SE to controller. Unit is MILLISECONDS. SeMetricsRtInterval *int32 `json:"se_metrics_rt_interval,omitempty"` // Internal use only. Used to artificially reduce the available number of packet buffers. SePacketBufferMax *int32 `json:"se_packet_buffer_max,omitempty"` // Internal use only. If enabled, randomly packets are dropped. SeRandomTCPDrops *bool `json:"se_random_tcp_drops,omitempty"` // SE rate limiters. SeRateLimiters *SeRateLimiters `json:"se_rate_limiters,omitempty"` // IP ranges on which there may be virtual services (for configuring iptables/routes). Maximum of 128 items allowed. ServiceIPSubnets []*IPAddrPrefix `json:"service_ip_subnets,omitempty"` // Port ranges on which there may be virtual services (for configuring iptables). Applicable in container ecosystems like Mesos. ServicePortRanges []*PortRange `json:"service_port_ranges,omitempty"` // Make service ports accessible on all Host interfaces in addition to East-West VIP and/or bridge IP. ServicesAccessibleAllInterfaces *bool `json:"services_accessible_all_interfaces,omitempty"` // Placeholder for description of property spdy_fwd_proxy_parse_enable of obj type SeRuntimeProperties field type str type boolean SpdyFwdProxyParseEnable *bool `json:"spdy_fwd_proxy_parse_enable,omitempty"` // Maximum size of the SYN cache table. After this limit is reached, SYN cookies are used. This is per core of the serviceengine. Field deprecated in 17.2.5. TCPSynCacheMax *int32 `json:"tcp_syn_cache_max,omitempty"` // Default value for max number of retransmissions for a SYN packet. TCPSyncacheMaxRetransmitDefault *int32 `json:"tcp_syncache_max_retransmit_default,omitempty"` // Timeout for backend connection. Unit is MILLISECONDS. UpstreamConnectTimeout *int32 `json:"upstream_connect_timeout,omitempty"` // L7 Upstream Connection pool cache threshold in percentage. UpstreamConnpoolCacheThresh *int32 `json:"upstream_connpool_cache_thresh,omitempty"` // Idle timeout value for a connection in the upstream connection pool, when the current cache size is above the threshold. UpstreamConnpoolConnIDLEThreshTmo *int32 `json:"upstream_connpool_conn_idle_thresh_tmo,omitempty"` // Deprecated. Field deprecated in 18.2.1. UpstreamConnpoolConnIDLETmo *int32 `json:"upstream_connpool_conn_idle_tmo,omitempty"` // Deprecated. Field deprecated in 18.2.1. UpstreamConnpoolConnLifeTmo *int32 `json:"upstream_connpool_conn_life_tmo,omitempty"` // Deprecated. Field deprecated in 18.2.1. UpstreamConnpoolConnMaxReuse *int32 `json:"upstream_connpool_conn_max_reuse,omitempty"` // L7 Upstream Connection pool max cache size per core. UpstreamConnpoolCoreMaxCache *int32 `json:"upstream_connpool_core_max_cache,omitempty"` // Enable upstream connection pool. UpstreamConnpoolEnable *bool `json:"upstream_connpool_enable,omitempty"` // Deprecated. Field deprecated in 18.2.1. UpstreamConnpoolServerMaxCache *int32 `json:"upstream_connpool_server_max_cache,omitempty"` // Number of upstream_connpool_strategy. UpstreamConnpoolStrategy *int32 `json:"upstream_connpool_strategy,omitempty"` // Placeholder for description of property upstream_keepalive of obj type SeRuntimeProperties field type str type boolean UpstreamKeepalive *bool `json:"upstream_keepalive,omitempty"` // Timeout for data to be received from backend. Unit is MILLISECONDS. UpstreamReadTimeout *int32 `json:"upstream_read_timeout,omitempty"` // Timeout for upstream to become writable. Unit is MILLISECONDS. Allowed in Basic(Allowed values- 3600000) edition, Essentials(Allowed values- 3600000) edition, Enterprise edition. UpstreamSendTimeout *int32 `json:"upstream_send_timeout,omitempty"` // Defines in seconds how long before an unused user-defined-metric is garbage collected. Field introduced in 17.1.5. Unit is SEC. UserDefinedMetricAge *int32 `json:"user_defined_metric_age,omitempty"` }
SeRuntimeProperties se runtime properties swagger:model SeRuntimeProperties
type SeThreshEventDetails ¶
type SeThreshEventDetails struct { // Number of curr_value. // Required: true CurrValue *int64 `json:"curr_value"` // Number of thresh. // Required: true Thresh *int64 `json:"thresh"` }
SeThreshEventDetails se thresh event details swagger:model SeThreshEventDetails
type SeUpgradeEventDetails ¶
type SeUpgradeEventDetails struct { // notes of SeUpgradeEventDetails. Notes []string `json:"notes,omitempty"` // Number of num_vs. NumVs *int32 `json:"num_vs,omitempty"` // Unique object identifier of se_grp. SeGrpUUID *string `json:"se_grp_uuid,omitempty"` // Unique object identifier of se. // Required: true SeUUID *string `json:"se_uuid"` }
SeUpgradeEventDetails se upgrade event details swagger:model SeUpgradeEventDetails
type SeUpgradeEvents ¶
type SeUpgradeEvents struct { // It is a reference to an object of type ServiceEngine. FromSeRef *string `json:"from_se_ref,omitempty"` // Number of num_se. NumSe *int32 `json:"num_se,omitempty"` // Number of num_se_group. NumSeGroup *int32 `json:"num_se_group,omitempty"` // Number of num_vs. NumVs *int32 `json:"num_vs,omitempty"` // reason of SeUpgradeEvents. Reason []string `json:"reason,omitempty"` // Enum options - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY. SeGroupHaMode *string `json:"se_group_ha_mode,omitempty"` // It is a reference to an object of type ServiceEngineGroup. SeGroupRef *string `json:"se_group_ref,omitempty"` // It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` // List of sub_tasks executed. Field introduced in 20.1.4. SubTasks []string `json:"sub_tasks,omitempty"` // Enum options - SE_UPGRADE_PREVIEW. SE_UPGRADE_IN_PROGRESS. SE_UPGRADE_COMPLETE. SE_UPGRADE_ERROR. SE_UPGRADE_PRE_CHECKS. SE_IMAGE_INSTALL. SE_UPGRADE_IMAGE_NOT_FOUND. SE_ALREADY_UPGRADED. SE_REBOOT. SE_CONNECT_AFTER_REBOOT. SE_PRE_UPGRADE_TASKS. SE_POST_UPGRADE_TASKS. SE_WAIT_FOR_SWITCHOVER. SE_CHECK_SCALEDOUT_VS_EXISTS. SE_UPGRADE_SEMGR_REQUEST. SE_UPGRADE_SEMGR_SE_UNREACHABLE. SE_PRE_UPGRADE_SCALE_IN_OPS. SE_POST_UPGRADE_SCALE_OUT_OPS. SE_UPGRADE_SUSPENDED. SE_UPGRADE_START... Task *string `json:"task,omitempty"` // It is a reference to an object of type ServiceEngine. ToSeRef *string `json:"to_se_ref,omitempty"` // Enum options - TRAFFIC_DISRUPTED, TRAFFIC_NOT_DISRUPTED. TrafficStatus *string `json:"traffic_status,omitempty"` // It is a reference to an object of type VirtualService. VsRef *string `json:"vs_ref,omitempty"` }
SeUpgradeEvents se upgrade events swagger:model SeUpgradeEvents
type SeUpgradeMigrateEventDetails ¶
type SeUpgradeMigrateEventDetails struct { // Placeholder for description of property migrate_params of obj type SeUpgradeMigrateEventDetails field type str type object MigrateParams *VsMigrateParams `json:"migrate_params,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
SeUpgradeMigrateEventDetails se upgrade migrate event details swagger:model SeUpgradeMigrateEventDetails
type SeUpgradeParams ¶
type SeUpgradeParams struct { // This field is used to disable scale-in/scale out operations during upgrade operations. . Disruptive *bool `json:"disruptive,omitempty"` // Field deprecated in 18.2.10, 20.1.1. Force *bool `json:"force,omitempty"` // Upgrade System with patch upgrade. Field introduced in 17.2.2. Patch *bool `json:"patch,omitempty"` // Rollback System with patch upgrade. PatchRollback *bool `json:"patch_rollback,omitempty"` // Resume from suspended state. ResumeFromSuspend *bool `json:"resume_from_suspend,omitempty"` // It is used in rollback operations. . Rollback *bool `json:"rollback,omitempty"` // It is a reference to an object of type ServiceEngineGroup. Field introduced in 17.2.2. SeGroupRefs []string `json:"se_group_refs,omitempty"` // When set, this will skip upgrade on the Service Engine which is upgrade suspended state. SkipSuspended *bool `json:"skip_suspended,omitempty"` // When set to true, if there is any failure during the SE upgrade, upgrade will be suspended for this SE group and manual intervention would be needed to resume the upgrade. Field introduced in 17.1.4. SuspendOnFailure *bool `json:"suspend_on_failure,omitempty"` // Field deprecated in 18.2.10, 20.1.1. Test *bool `json:"test,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
SeUpgradeParams se upgrade params swagger:model SeUpgradeParams
type SeUpgradeScaleinEventDetails ¶
type SeUpgradeScaleinEventDetails struct { // Placeholder for description of property scalein_params of obj type SeUpgradeScaleinEventDetails field type str type object ScaleinParams *VsScaleinParams `json:"scalein_params,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
SeUpgradeScaleinEventDetails se upgrade scalein event details swagger:model SeUpgradeScaleinEventDetails
type SeUpgradeScaleoutEventDetails ¶
type SeUpgradeScaleoutEventDetails struct { // Placeholder for description of property scaleout_params of obj type SeUpgradeScaleoutEventDetails field type str type object ScaleoutParams *VsScaleoutParams `json:"scaleout_params,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
SeUpgradeScaleoutEventDetails se upgrade scaleout event details swagger:model SeUpgradeScaleoutEventDetails
type SeUpgradeStatusSummary ¶
type SeUpgradeStatusSummary struct { // controller_version of SeUpgradeStatusSummary. ControllerVersion *string `json:"controller_version,omitempty"` // duration of SeUpgradeStatusSummary. Duration *string `json:"duration,omitempty"` // end_time of SeUpgradeStatusSummary. EndTime *string `json:"end_time,omitempty"` // Placeholder for description of property in_progress of obj type SeUpgradeStatusSummary field type str type boolean InProgress *bool `json:"in_progress,omitempty"` // notes of SeUpgradeStatusSummary. Notes []string `json:"notes,omitempty"` // It is a reference to an object of type ServiceEngine. SeAlreadyUpgradedAtStart []string `json:"se_already_upgraded_at_start,omitempty"` // It is a reference to an object of type ServiceEngine. SeDisconnectedAtStart []string `json:"se_disconnected_at_start,omitempty"` // Placeholder for description of property se_group_status of obj type SeUpgradeStatusSummary field type str type object SeGroupStatus []*SeGroupStatus `json:"se_group_status,omitempty"` // It is a reference to an object of type ServiceEngine. SeIPMissingAtStart []string `json:"se_ip_missing_at_start,omitempty"` // It is a reference to an object of type ServiceEngine. SePoweredoffAtStart []string `json:"se_poweredoff_at_start,omitempty"` // It is a reference to an object of type ServiceEngine. SeUpgradeCompleted []string `json:"se_upgrade_completed,omitempty"` // Placeholder for description of property se_upgrade_errors of obj type SeUpgradeStatusSummary field type str type object SeUpgradeErrors []*SeUpgradeEvents `json:"se_upgrade_errors,omitempty"` // It is a reference to an object of type ServiceEngine. SeUpgradeFailed []string `json:"se_upgrade_failed,omitempty"` // It is a reference to an object of type ServiceEngine. SeUpgradeInProgress []string `json:"se_upgrade_in_progress,omitempty"` // It is a reference to an object of type ServiceEngine. SeUpgradeNotStarted []string `json:"se_upgrade_not_started,omitempty"` // It is a reference to an object of type ServiceEngine. SeUpgradeRetryCompleted []string `json:"se_upgrade_retry_completed,omitempty"` // It is a reference to an object of type ServiceEngine. SeUpgradeRetryFailed []string `json:"se_upgrade_retry_failed,omitempty"` // It is a reference to an object of type ServiceEngine. SeUpgradeRetryInProgress []string `json:"se_upgrade_retry_in_progress,omitempty"` // Service Engines that were in suspended state and were skipped upon Service Engine Group upgrade resumption. It is a reference to an object of type ServiceEngine. SeUpgradeSkipSuspended []string `json:"se_upgrade_skip_suspended,omitempty"` // Service Engines which triggered Service Engine Group to be in suspended state. It is a reference to an object of type ServiceEngine. SeUpgradeSuspended []string `json:"se_upgrade_suspended,omitempty"` // start_time of SeUpgradeStatusSummary. StartTime *string `json:"start_time,omitempty"` // Enum options - SE_UPGRADE_PREVIEW. SE_UPGRADE_IN_PROGRESS. SE_UPGRADE_COMPLETE. SE_UPGRADE_ERROR. SE_UPGRADE_PRE_CHECKS. SE_IMAGE_INSTALL. SE_UPGRADE_IMAGE_NOT_FOUND. SE_ALREADY_UPGRADED. SE_REBOOT. SE_CONNECT_AFTER_REBOOT. SE_PRE_UPGRADE_TASKS. SE_POST_UPGRADE_TASKS. SE_WAIT_FOR_SWITCHOVER. SE_CHECK_SCALEDOUT_VS_EXISTS. SE_UPGRADE_SEMGR_REQUEST. SE_UPGRADE_SEMGR_SE_UNREACHABLE. SE_PRE_UPGRADE_SCALE_IN_OPS. SE_POST_UPGRADE_SCALE_OUT_OPS. SE_UPGRADE_SUSPENDED. SE_UPGRADE_START... State *string `json:"state,omitempty"` // Placeholder for description of property vs_errors of obj type SeUpgradeStatusSummary field type str type object VsErrors []*VsError `json:"vs_errors,omitempty"` }
SeUpgradeStatusSummary se upgrade status summary swagger:model SeUpgradeStatusSummary
type SeUpgradeVsDisruptedEventDetails ¶
type SeUpgradeVsDisruptedEventDetails struct { // ip of SeUpgradeVsDisruptedEventDetails. IP *string `json:"ip,omitempty"` // notes of SeUpgradeVsDisruptedEventDetails. Notes []string `json:"notes,omitempty"` // vip_id of SeUpgradeVsDisruptedEventDetails. VipID *string `json:"vip_id,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
SeUpgradeVsDisruptedEventDetails se upgrade vs disrupted event details swagger:model SeUpgradeVsDisruptedEventDetails
type SeVersionCheckFailedEvent ¶
type SeVersionCheckFailedEvent struct { // Software version on the controller. ControllerVersion *string `json:"controller_version,omitempty"` // UUID of the SE. SeUUID *string `json:"se_uuid,omitempty"` // Software version on the SE. SeVersion *string `json:"se_version,omitempty"` }
SeVersionCheckFailedEvent se version check failed event swagger:model SeVersionCheckFailedEvent
type SeVipInterfaceList ¶
type SeVipInterfaceList struct { // Placeholder for description of property is_portchannel of obj type SeVipInterfaceList field type str type boolean IsPortchannel *bool `json:"is_portchannel,omitempty"` // Placeholder for description of property vip_intf_ip of obj type SeVipInterfaceList field type str type object VipIntfIP *IPAddr `json:"vip_intf_ip,omitempty"` // Placeholder for description of property vip_intf_ip6 of obj type SeVipInterfaceList field type str type object VipIntfIp6 *IPAddr `json:"vip_intf_ip6,omitempty"` // vip_intf_mac of SeVipInterfaceList. // Required: true VipIntfMac *string `json:"vip_intf_mac"` // Number of vlan_id. VlanID *int32 `json:"vlan_id,omitempty"` }
SeVipInterfaceList se vip interface list swagger:model SeVipInterfaceList
type SeVnicDownEventDetails ¶
type SeVnicDownEventDetails struct { // Vnic name. IfName *string `json:"if_name,omitempty"` // Vnic linux name. LinuxName *string `json:"linux_name,omitempty"` // Mac Address. Mac *string `json:"mac,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` }
SeVnicDownEventDetails se vnic down event details swagger:model SeVnicDownEventDetails
type SeVnicTxQueueStallEventDetails ¶
type SeVnicTxQueueStallEventDetails struct { // Vnic name. IfName *string `json:"if_name,omitempty"` // Vnic Linux name. LinuxName *string `json:"linux_name,omitempty"` // Queue number. Queue *int32 `json:"queue,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` }
SeVnicTxQueueStallEventDetails se vnic tx queue stall event details swagger:model SeVnicTxQueueStallEventDetails
type SeVnicUpEventDetails ¶
type SeVnicUpEventDetails struct { // Vnic name. IfName *string `json:"if_name,omitempty"` // Vnic linux name. LinuxName *string `json:"linux_name,omitempty"` // Mac Address. Mac *string `json:"mac,omitempty"` // UUID of the SE responsible for this event. It is a reference to an object of type ServiceEngine. SeRef *string `json:"se_ref,omitempty"` }
SeVnicUpEventDetails se vnic up event details swagger:model SeVnicUpEventDetails
type SeVsFaultEventDetails ¶
type SeVsFaultEventDetails struct { // Name of the object responsible for the fault. FaultObject *string `json:"fault_object,omitempty"` // Reason for the fault. FaultReason *string `json:"fault_reason,omitempty"` // SE uuid. It is a reference to an object of type ServiceEngine. ServiceEngine *string `json:"service_engine,omitempty"` // VS name. It is a reference to an object of type VirtualService. VirtualService *string `json:"virtual_service,omitempty"` }
SeVsFaultEventDetails se vs fault event details swagger:model SeVsFaultEventDetails
type SeVsPktBufHighEventDetails ¶
type SeVsPktBufHighEventDetails struct { // Current packet buffer usage of the VS. CurrentValue *int32 `json:"current_value,omitempty"` // Buffer usage threshold value. Threshold *int32 `json:"threshold,omitempty"` // Virtual Service name. It is a reference to an object of type VirtualService. VirtualService *string `json:"virtual_service,omitempty"` }
SeVsPktBufHighEventDetails se vs pkt buf high event details swagger:model SeVsPktBufHighEventDetails
type SecMgrDataEvent ¶
type SecMgrDataEvent struct { // Type of the generated for an application. Field introduced in 20.1.1. Error *string `json:"error,omitempty"` // Name of the application. Field introduced in 20.1.1. Name *string `json:"name,omitempty"` }
SecMgrDataEvent sec mgr data event swagger:model SecMgrDataEvent
type SecMgrThreshold ¶
type SecMgrThreshold struct { // Enum options - LAND, SMURF, ICMP_PING_FLOOD, UNKOWN_PROTOCOL, TEARDROP, IP_FRAG_OVERRUN, IP_FRAG_TOOSMALL, IP_FRAG_FULL, IP_FRAG_INCOMPLETE, PORT_SCAN, TCP_NON_SYN_FLOOD_OLD, SYN_FLOOD, BAD_RST_FLOOD, MALFORMED_FLOOD, FAKE_SESSION, ZERO_WINDOW_STRESS, SMALL_WINDOW_STRESS, DOS_HTTP_TIMEOUT, DOS_HTTP_ERROR, DOS_HTTP_ABORT, DOS_SSL_ERROR, DOS_APP_ERROR, DOS_REQ_IP_RL_DROP, DOS_REQ_URI_RL_DROP, DOS_REQ_URI_SCAN_BAD_RL_DROP, DOS_REQ_URI_SCAN_UNKNOWN_RL_DROP, DOS_REQ_IP_URI_RL_DROP, DOS_CONN_IP_RL_DROP, DOS_SLOW_URL, TCP_NON_SYN_FLOOD, DOS_REQ_CIP_SCAN_BAD_RL_DROP, DOS_REQ_CIP_SCAN_UNKNOWN_RL_DROP, DOS_REQ_IP_RL_DROP_BAD, DOS_REQ_URI_RL_DROP_BAD, DOS_REQ_IP_URI_RL_DROP_BAD, POLICY_DROPS, DOS_CONN_RL_DROP, DOS_REQ_RL_DROP, DOS_REQ_HDR_RL_DROP, DOS_REQ_CUSTOM_RL_DROP, DNS_ATTACK_REFLECTION. Field introduced in 18.2.5. // Required: true AttackType *string `json:"attack_type"` // Field introduced in 18.2.5. // Required: true Threshold *int64 `json:"threshold"` }
SecMgrThreshold sec mgr threshold swagger:model SecMgrThreshold
type SecureChannelAvailableLocalIps ¶
type SecureChannelAvailableLocalIps struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Number of end. End *int32 `json:"end,omitempty"` // free_controller_ips of SecureChannelAvailableLocalIPs. FreeControllerIps []string `json:"free_controller_ips,omitempty"` // free_ips of SecureChannelAvailableLocalIPs. FreeIps []string `json:"free_ips,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Number of start. Start *int32 `json:"start,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
SecureChannelAvailableLocalIps secure channel available local ips swagger:model SecureChannelAvailableLocalIPs
type SecureChannelAvailableLocalIpsAPIResponse ¶
type SecureChannelAvailableLocalIpsAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SecureChannelAvailableLocalIps `json:"results,omitempty"` }
SecureChannelAvailableLocalIpsAPIResponse secure channel available local ips Api response swagger:model SecureChannelAvailableLocalIPsApiResponse
type SecureChannelConfiguration ¶
type SecureChannelConfiguration struct { // Boolean which allowed force update of secure channel certificate. Forced updating has been disallowed. Field deprecated in 18.2.8. Field introduced in 18.2.5. BypassSecureChannelMustChecks *bool `json:"bypass_secure_channel_must_checks,omitempty"` // Certificate for secure channel. Leave list empty to use system default certs. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 18.1.4, 18.2.1. Maximum of 1 items allowed. SslkeyandcertificateRefs []string `json:"sslkeyandcertificate_refs,omitempty"` }
SecureChannelConfiguration secure channel configuration swagger:model SecureChannelConfiguration
type SecureChannelMapping ¶
type SecureChannelMapping struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // ip of SecureChannelMapping. IP *string `json:"ip,omitempty"` // Placeholder for description of property is_controller of obj type SecureChannelMapping field type str type boolean IsController *bool `json:"is_controller,omitempty"` // local_ip of SecureChannelMapping. LocalIP *string `json:"local_ip,omitempty"` // Placeholder for description of property marked_for_delete of obj type SecureChannelMapping field type str type boolean MarkedForDelete *bool `json:"marked_for_delete,omitempty"` // Metadata associated with the SecureChannelToken of the service engine. Field introduced in 20.1.3. Metadata []*SecureChannelMetadata `json:"metadata,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // pub_key of SecureChannelMapping. PubKey *string `json:"pub_key,omitempty"` // pub_key_pem of SecureChannelMapping. PubKeyPem *string `json:"pub_key_pem,omitempty"` // Enum options - SECURE_CHANNEL_NONE, SECURE_CHANNEL_CONNECTED, SECURE_CHANNEL_AUTH_SSH_SUCCESS, SECURE_CHANNEL_AUTH_SSH_FAILED, SECURE_CHANNEL_AUTH_TOKEN_SUCCESS, SECURE_CHANNEL_AUTH_TOKEN_FAILED, SECURE_CHANNEL_AUTH_ERRORS, SECURE_CHANNEL_AUTH_IGNORED. Status *string `json:"status,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
SecureChannelMapping secure channel mapping swagger:model SecureChannelMapping
type SecureChannelMappingAPIResponse ¶
type SecureChannelMappingAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SecureChannelMapping `json:"results,omitempty"` }
SecureChannelMappingAPIResponse secure channel mapping Api response swagger:model SecureChannelMappingApiResponse
type SecureChannelMetadata ¶
type SecureChannelMetadata struct { // key of SecureChannelMetadata. Key *string `json:"key,omitempty"` // val of SecureChannelMetadata. Val *string `json:"val,omitempty"` }
SecureChannelMetadata secure channel metadata swagger:model SecureChannelMetadata
type SecureChannelToken ¶
type SecureChannelToken struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Expiry time for secure channel. ExpiryTime *float64 `json:"expiry_time,omitempty"` // Placeholder for description of property metadata of obj type SecureChannelToken field type str type object Metadata []*SecureChannelMetadata `json:"metadata,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Unique object identifier of node. NodeUUID *string `json:"node_uuid,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
SecureChannelToken secure channel token swagger:model SecureChannelToken
type SecureChannelTokenAPIResponse ¶
type SecureChannelTokenAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SecureChannelToken `json:"results,omitempty"` }
SecureChannelTokenAPIResponse secure channel token Api response swagger:model SecureChannelTokenApiResponse
type SecureKeyExchangeDetails ¶
type SecureKeyExchangeDetails struct { // Controller managememt IP for secure key exchange between controller and SE. Field introduced in 20.1.3. CtlrMgmtIP *string `json:"ctlr_mgmt_ip,omitempty"` // Controller public IP for secure key exchange between controller and SE. Field introduced in 20.1.3. CtlrPublicIP *string `json:"ctlr_public_ip,omitempty"` // Error message if secure key exchange failed. Field introduced in 20.1.3. Error *string `json:"error,omitempty"` // Follower IP for secure key exchange between controller and controller. Field introduced in 20.1.3. FollowerIP *string `json:"follower_ip,omitempty"` // Leader IP for secure key exchange between controller and controller. Field introduced in 20.1.3. LeaderIP *string `json:"leader_ip,omitempty"` // name of SE/controller who initiates the secure key exchange. Field introduced in 20.1.3. Name *string `json:"name,omitempty"` // SE IP for secure key exchange between controller and SE. Field introduced in 20.1.3. SeIP *string `json:"se_ip,omitempty"` // IP address of the client. Field introduced in 20.1.3. SourceIP *string `json:"source_ip,omitempty"` // Status. Enum options - SYSERR_SUCCESS, SYSERR_FAILURE, SYSERR_OUT_OF_MEMORY, SYSERR_NO_ENT, SYSERR_INVAL, SYSERR_ACCESS, SYSERR_FAULT, SYSERR_IO, SYSERR_TIMEOUT, SYSERR_NOT_SUPPORTED, SYSERR_NOT_READY, SYSERR_UPGRADE_IN_PROGRESS, SYSERR_WARM_START_IN_PROGRESS, SYSERR_TRY_AGAIN, SYSERR_NOT_UPGRADING, SYSERR_PENDING, SYSERR_EVENT_GEN_FAILURE, SYSERR_CONFIG_PARAM_MISSING, SYSERR_RANGE, SYSERR_BAD_REQUEST.... Field introduced in 20.1.3. Status *string `json:"status,omitempty"` // uuid of SE/controller who initiates the secure key exchange. Field introduced in 20.1.3. UUID *string `json:"uuid,omitempty"` }
SecureKeyExchangeDetails secure key exchange details swagger:model SecureKeyExchangeDetails
type SecurityManagerData ¶
type SecurityManagerData struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Information about various applications. Field introduced in 20.1.1. AppLearningInfo []*DbAppLearningInfo `json:"app_learning_info,omitempty"` // Virtualservice Name. Field introduced in 20.1.1. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 20.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Virtualservice UUID. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` }
SecurityManagerData security manager data swagger:model SecurityManagerData
type SecurityManagerDataAPIResponse ¶
type SecurityManagerDataAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SecurityManagerData `json:"results,omitempty"` }
SecurityManagerDataAPIResponse security manager data Api response swagger:model SecurityManagerDataApiResponse
type SecurityMgrDebugFilter ¶
type SecurityMgrDebugFilter struct { // Dynamically adapt configuration parameters for Application Learning feature. Field introduced in 20.1.1. EnableAdaptiveConfig *bool `json:"enable_adaptive_config,omitempty"` // uuid of the entity. It is a reference to an object of type Virtualservice. Field introduced in 18.2.6. EntityRef *string `json:"entity_ref,omitempty"` }
SecurityMgrDebugFilter security mgr debug filter swagger:model SecurityMgrDebugFilter
type SecurityMgrRuntime ¶
type SecurityMgrRuntime struct { // Field introduced in 18.2.5. Thresholds []*SecMgrThreshold `json:"thresholds,omitempty"` }
SecurityMgrRuntime security mgr runtime swagger:model SecurityMgrRuntime
type SecurityPolicy ¶
type SecurityPolicy struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Security policy is used to specify various configuration information used to perform Distributed Denial of Service (DDoS) attacks detection and mitigation. Field introduced in 18.2.1. Description *string `json:"description,omitempty"` // Attacks utilizing the DNS protocol operations. Field introduced in 18.2.1. DNSAttacks *DNSAttacks `json:"dns_attacks,omitempty"` // Index of the dns policy to use for the mitigation rules applied to the dns attacks. Field introduced in 18.2.1. // Required: true DNSPolicyIndex *int32 `json:"dns_policy_index"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // The name of the security policy. Field introduced in 18.2.1. // Required: true Name *string `json:"name"` // Index of the network security policy to use for the mitigation rules applied to the attacks. Field introduced in 18.2.1. // Required: true NetworkSecurityPolicyIndex *int32 `json:"network_security_policy_index"` // Mode of dealing with the attacks - perform detection only, or detect and mitigate the attacks. Enum options - DETECTION, MITIGATION. Field introduced in 18.2.1. OperMode *string `json:"oper_mode,omitempty"` // Attacks utilizing the TCP protocol operations. Field introduced in 18.2.1. TCPAttacks TCPAttacks `json:"tcp_attacks,omitempty"` // Tenancy of the security policy. It is a reference to an object of type Tenant. Field introduced in 18.2.1. TenantRef *string `json:"tenant_ref,omitempty"` // Attacks utilizing the UDP protocol operations. Field introduced in 18.2.1. UDPAttacks UDPAttacks `json:"udp_attacks,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // The UUID of the security policy. Field introduced in 18.2.1. UUID *string `json:"uuid,omitempty"` }
SecurityPolicy security policy swagger:model SecurityPolicy
type SecurityPolicyAPIResponse ¶
type SecurityPolicyAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SecurityPolicy `json:"results,omitempty"` }
SecurityPolicyAPIResponse security policy Api response swagger:model SecurityPolicyApiResponse
type Selector ¶
type Selector struct { // Labels as key value pairs to select on. Field introduced in 20.1.3. Minimum of 1 items required. Labels []*KeyValueTuple `json:"labels,omitempty"` // Selector type. Enum options - SELECTOR_IPAM. Field introduced in 20.1.3. // Required: true Type *string `json:"type"` }
Selector selector swagger:model Selector
type SensitiveFieldRule ¶
type SensitiveFieldRule struct { // Action for the matched log field, for instance the matched field can be removed or masked off. Enum options - LOG_FIELD_REMOVE, LOG_FIELD_MASKOFF. Field introduced in 17.2.10, 18.1.2. Action *string `json:"action,omitempty"` // Enable rule to match the sensitive fields. Field introduced in 17.2.10, 18.1.2. Enabled *bool `json:"enabled,omitempty"` // Index of the rule. Field introduced in 17.2.10, 18.1.2. Index *int32 `json:"index,omitempty"` // Criterion to use for matching in the Log. Field introduced in 17.2.10, 18.1.2. Allowed in Basic edition, Essentials edition, Enterprise edition. Match *StringMatch `json:"match,omitempty"` // Name of the rule. Field introduced in 17.2.10, 18.1.2. Name *string `json:"name,omitempty"` }
SensitiveFieldRule sensitive field rule swagger:model SensitiveFieldRule
type SensitiveLogProfile ¶
type SensitiveLogProfile struct { // Match sensitive header fields in HTTP application log. Field introduced in 17.2.10, 18.1.2. HeaderFieldRules []*SensitiveFieldRule `json:"header_field_rules,omitempty"` // Match sensitive WAF log fields in HTTP application log. Field introduced in 17.2.13, 18.1.3. WafFieldRules []*SensitiveFieldRule `json:"waf_field_rules,omitempty"` }
SensitiveLogProfile sensitive log profile swagger:model SensitiveLogProfile
type Server ¶
type Server struct { // Name of autoscaling group this server belongs to. Field introduced in 17.1.2. Allowed in Essentials edition, Enterprise edition. AutoscalingGroupName *string `json:"autoscaling_group_name,omitempty"` // Availability-zone of the server VM. AvailabilityZone *string `json:"availability_zone,omitempty"` // A description of the Server. Description *string `json:"description,omitempty"` // (internal-use) Discovered network for this server. This field is deprecated. It is a reference to an object of type Network. Field deprecated in 17.1.1. DiscoveredNetworkRef []string `json:"discovered_network_ref,omitempty"` // (internal-use) Discovered networks providing reachability for server IP. This field is used internally by Avi, not editable by the user. DiscoveredNetworks []*DiscoveredNetwork `json:"discovered_networks,omitempty"` // (internal-use) Discovered subnet for this server. This field is deprecated. Field deprecated in 17.1.1. DiscoveredSubnet []*IPAddrPrefix `json:"discovered_subnet,omitempty"` // Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed. Enabled *bool `json:"enabled,omitempty"` // UID of server in external orchestration systems. ExternalOrchestrationID *string `json:"external_orchestration_id,omitempty"` // UUID identifying VM in OpenStack and other external compute. ExternalUUID *string `json:"external_uuid,omitempty"` // DNS resolvable name of the server. May be used in place of the IP address. Hostname *string `json:"hostname,omitempty"` // IP Address of the server. Required if there is no resolvable host name. // Required: true IP *IPAddr `json:"ip"` // (internal-use) Geographic location of the server.Currently only for internal usage. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. Location *GeoLocation `json:"location,omitempty"` // MAC address of server. MacAddress *string `json:"mac_address,omitempty"` // (internal-use) This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrNWRuntime. NwRef *string `json:"nw_ref,omitempty"` // Optionally specify the servers port number. This will override the pool's default server port attribute. Allowed values are 1-65535. Special values are 0- 'use backend port in pool'. Port *int32 `json:"port,omitempty"` // Header value for custom header persistence. . PrstHdrVal *string `json:"prst_hdr_val,omitempty"` // Ratio of selecting eligible servers in the pool. Allowed values are 1-20. Ratio *int32 `json:"ratio,omitempty"` // Auto resolve server's IP using DNS name. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ResolveServerByDNS *bool `json:"resolve_server_by_dns,omitempty"` // Rewrite incoming Host Header to server name. RewriteHostHeader *bool `json:"rewrite_host_header,omitempty"` // Hostname of the node where the server VM or container resides. ServerNode *string `json:"server_node,omitempty"` // If statically learned. Static *bool `json:"static,omitempty"` // Verify server belongs to a discovered network or reachable via a discovered network. Verify reachable network isn't the OpenStack management network. VerifyNetwork *bool `json:"verify_network,omitempty"` // (internal-use) This field is used internally by Avi, not editable by the user. It is a reference to an object of type VIMgrVMRuntime. VMRef *string `json:"vm_ref,omitempty"` }
Server server swagger:model Server
type ServerAutoScaleFailedInfo ¶
type ServerAutoScaleFailedInfo struct { // Number of num_scalein_servers. // Required: true NumScaleinServers *int32 `json:"num_scalein_servers"` // Number of num_servers_up. // Required: true NumServersUp *int32 `json:"num_servers_up"` // UUID of the Pool. It is a reference to an object of type Pool. // Required: true PoolRef *string `json:"pool_ref"` // reason of ServerAutoScaleFailedInfo. Reason *string `json:"reason,omitempty"` // Enum options - SYSERR_SUCCESS. SYSERR_FAILURE. SYSERR_OUT_OF_MEMORY. SYSERR_NO_ENT. SYSERR_INVAL. SYSERR_ACCESS. SYSERR_FAULT. SYSERR_IO. SYSERR_TIMEOUT. SYSERR_NOT_SUPPORTED. SYSERR_NOT_READY. SYSERR_UPGRADE_IN_PROGRESS. SYSERR_WARM_START_IN_PROGRESS. SYSERR_TRY_AGAIN. SYSERR_NOT_UPGRADING. SYSERR_PENDING. SYSERR_EVENT_GEN_FAILURE. SYSERR_CONFIG_PARAM_MISSING. SYSERR_RANGE. SYSERR_BAD_REQUEST... // Required: true ReasonCode *string `json:"reason_code"` }
ServerAutoScaleFailedInfo server auto scale failed info swagger:model ServerAutoScaleFailedInfo
type ServerAutoScaleInCompleteInfo ¶
type ServerAutoScaleInCompleteInfo struct { // Number of nscalein. // Required: true Nscalein *int32 `json:"nscalein"` // UUID of the Pool. It is a reference to an object of type Pool. // Required: true PoolRef *string `json:"pool_ref"` // reason of ServerAutoScaleInCompleteInfo. Reason *string `json:"reason,omitempty"` // Enum options - SYSERR_SUCCESS. SYSERR_FAILURE. SYSERR_OUT_OF_MEMORY. SYSERR_NO_ENT. SYSERR_INVAL. SYSERR_ACCESS. SYSERR_FAULT. SYSERR_IO. SYSERR_TIMEOUT. SYSERR_NOT_SUPPORTED. SYSERR_NOT_READY. SYSERR_UPGRADE_IN_PROGRESS. SYSERR_WARM_START_IN_PROGRESS. SYSERR_TRY_AGAIN. SYSERR_NOT_UPGRADING. SYSERR_PENDING. SYSERR_EVENT_GEN_FAILURE. SYSERR_CONFIG_PARAM_MISSING. SYSERR_RANGE. SYSERR_BAD_REQUEST... // Required: true ReasonCode *string `json:"reason_code"` // Placeholder for description of property scaled_in_servers of obj type ServerAutoScaleInCompleteInfo field type str type object ScaledInServers []*ServerID `json:"scaled_in_servers,omitempty"` }
ServerAutoScaleInCompleteInfo server auto scale in complete info swagger:model ServerAutoScaleInCompleteInfo
type ServerAutoScaleInInfo ¶
type ServerAutoScaleInInfo struct { // alertconfig_name of ServerAutoScaleInInfo. AlertconfigName *string `json:"alertconfig_name,omitempty"` // It is a reference to an object of type AlertConfig. AlertconfigRef *string `json:"alertconfig_ref,omitempty"` // Placeholder for description of property available_capacity of obj type ServerAutoScaleInInfo field type str type number AvailableCapacity *float64 `json:"available_capacity,omitempty"` // Placeholder for description of property load of obj type ServerAutoScaleInInfo field type str type number Load *float64 `json:"load,omitempty"` // Number of num_scalein_servers. // Required: true NumScaleinServers *int32 `json:"num_scalein_servers"` // Number of num_servers_up. // Required: true NumServersUp *int32 `json:"num_servers_up"` // UUID of the Pool. It is a reference to an object of type Pool. // Required: true PoolRef *string `json:"pool_ref"` // reason of ServerAutoScaleInInfo. Reason *string `json:"reason,omitempty"` // Enum options - SYSERR_SUCCESS. SYSERR_FAILURE. SYSERR_OUT_OF_MEMORY. SYSERR_NO_ENT. SYSERR_INVAL. SYSERR_ACCESS. SYSERR_FAULT. SYSERR_IO. SYSERR_TIMEOUT. SYSERR_NOT_SUPPORTED. SYSERR_NOT_READY. SYSERR_UPGRADE_IN_PROGRESS. SYSERR_WARM_START_IN_PROGRESS. SYSERR_TRY_AGAIN. SYSERR_NOT_UPGRADING. SYSERR_PENDING. SYSERR_EVENT_GEN_FAILURE. SYSERR_CONFIG_PARAM_MISSING. SYSERR_RANGE. SYSERR_BAD_REQUEST... ReasonCode *string `json:"reason_code,omitempty"` // Placeholder for description of property scalein_server_candidates of obj type ServerAutoScaleInInfo field type str type object ScaleinServerCandidates []*ServerID `json:"scalein_server_candidates,omitempty"` }
ServerAutoScaleInInfo server auto scale in info swagger:model ServerAutoScaleInInfo
type ServerAutoScaleOutCompleteInfo ¶
type ServerAutoScaleOutCompleteInfo struct { // Unique object identifier of launch_config. LaunchConfigUUID *string `json:"launch_config_uuid,omitempty"` // Number of nscaleout. // Required: true Nscaleout *int32 `json:"nscaleout"` // UUID of the Pool. It is a reference to an object of type Pool. // Required: true PoolRef *string `json:"pool_ref"` // reason of ServerAutoScaleOutCompleteInfo. Reason *string `json:"reason,omitempty"` // Enum options - SYSERR_SUCCESS. SYSERR_FAILURE. SYSERR_OUT_OF_MEMORY. SYSERR_NO_ENT. SYSERR_INVAL. SYSERR_ACCESS. SYSERR_FAULT. SYSERR_IO. SYSERR_TIMEOUT. SYSERR_NOT_SUPPORTED. SYSERR_NOT_READY. SYSERR_UPGRADE_IN_PROGRESS. SYSERR_WARM_START_IN_PROGRESS. SYSERR_TRY_AGAIN. SYSERR_NOT_UPGRADING. SYSERR_PENDING. SYSERR_EVENT_GEN_FAILURE. SYSERR_CONFIG_PARAM_MISSING. SYSERR_RANGE. SYSERR_BAD_REQUEST... // Required: true ReasonCode *string `json:"reason_code"` // Placeholder for description of property scaled_out_servers of obj type ServerAutoScaleOutCompleteInfo field type str type object ScaledOutServers []*ServerID `json:"scaled_out_servers,omitempty"` }
ServerAutoScaleOutCompleteInfo server auto scale out complete info swagger:model ServerAutoScaleOutCompleteInfo
type ServerAutoScaleOutInfo ¶
type ServerAutoScaleOutInfo struct { // alertconfig_name of ServerAutoScaleOutInfo. AlertconfigName *string `json:"alertconfig_name,omitempty"` // It is a reference to an object of type AlertConfig. AlertconfigRef *string `json:"alertconfig_ref,omitempty"` // Placeholder for description of property available_capacity of obj type ServerAutoScaleOutInfo field type str type number AvailableCapacity *float64 `json:"available_capacity,omitempty"` // Placeholder for description of property load of obj type ServerAutoScaleOutInfo field type str type number Load *float64 `json:"load,omitempty"` // Number of num_scaleout_servers. // Required: true NumScaleoutServers *int32 `json:"num_scaleout_servers"` // Number of num_servers_up. // Required: true NumServersUp *int32 `json:"num_servers_up"` // UUID of the Pool. It is a reference to an object of type Pool. // Required: true PoolRef *string `json:"pool_ref"` // reason of ServerAutoScaleOutInfo. Reason *string `json:"reason,omitempty"` // Enum options - SYSERR_SUCCESS. SYSERR_FAILURE. SYSERR_OUT_OF_MEMORY. SYSERR_NO_ENT. SYSERR_INVAL. SYSERR_ACCESS. SYSERR_FAULT. SYSERR_IO. SYSERR_TIMEOUT. SYSERR_NOT_SUPPORTED. SYSERR_NOT_READY. SYSERR_UPGRADE_IN_PROGRESS. SYSERR_WARM_START_IN_PROGRESS. SYSERR_TRY_AGAIN. SYSERR_NOT_UPGRADING. SYSERR_PENDING. SYSERR_EVENT_GEN_FAILURE. SYSERR_CONFIG_PARAM_MISSING. SYSERR_RANGE. SYSERR_BAD_REQUEST... ReasonCode *string `json:"reason_code,omitempty"` }
ServerAutoScaleOutInfo server auto scale out info swagger:model ServerAutoScaleOutInfo
type ServerAutoScalePolicy ¶
type ServerAutoScalePolicy struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Delay in minutes after which a down server will be removed from Pool. Value 0 disables this functionality. Field introduced in 20.1.3. DelayForServerGarbageCollection *int32 `json:"delay_for_server_garbage_collection,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Use Avi intelligent autoscale algorithm where autoscale is performed by comparing load on the pool against estimated capacity of all the servers. IntelligentAutoscale *bool `json:"intelligent_autoscale,omitempty"` // Maximum extra capacity as percentage of load used by the intelligent scheme. Scalein is triggered when available capacity is more than this margin. Allowed values are 1-99. IntelligentScaleinMargin *int32 `json:"intelligent_scalein_margin,omitempty"` // Minimum extra capacity as percentage of load used by the intelligent scheme. Scaleout is triggered when available capacity is less than this margin. Allowed values are 1-99. IntelligentScaleoutMargin *int32 `json:"intelligent_scaleout_margin,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.3. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Maximum number of servers to scalein simultaneously. The actual number of servers to scalein is chosen such that target number of servers is always more than or equal to the min_size. MaxScaleinAdjustmentStep *int32 `json:"max_scalein_adjustment_step,omitempty"` // Maximum number of servers to scaleout simultaneously. The actual number of servers to scaleout is chosen such that target number of servers is always less than or equal to the max_size. MaxScaleoutAdjustmentStep *int32 `json:"max_scaleout_adjustment_step,omitempty"` // Maximum number of servers after scaleout. Allowed values are 0-400. MaxSize *int32 `json:"max_size,omitempty"` // No scale-in happens once number of operationally up servers reach min_servers. Allowed values are 0-400. MinSize *int32 `json:"min_size,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Trigger scalein when alerts due to any of these Alert configurations are raised. It is a reference to an object of type AlertConfig. ScaleinAlertconfigRefs []string `json:"scalein_alertconfig_refs,omitempty"` // Cooldown period during which no new scalein is triggered to allow previous scalein to successfully complete. Unit is SEC. ScaleinCooldown *int32 `json:"scalein_cooldown,omitempty"` // Trigger scaleout when alerts due to any of these Alert configurations are raised. It is a reference to an object of type AlertConfig. ScaleoutAlertconfigRefs []string `json:"scaleout_alertconfig_refs,omitempty"` // Cooldown period during which no new scaleout is triggered to allow previous scaleout to successfully complete. Unit is SEC. ScaleoutCooldown *int32 `json:"scaleout_cooldown,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Use predicted load rather than current load. UsePredictedLoad *bool `json:"use_predicted_load,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
ServerAutoScalePolicy server auto scale policy swagger:model ServerAutoScalePolicy
type ServerAutoScalePolicyAPIResponse ¶
type ServerAutoScalePolicyAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ServerAutoScalePolicy `json:"results,omitempty"` }
ServerAutoScalePolicyAPIResponse server auto scale policy Api response swagger:model ServerAutoScalePolicyApiResponse
type ServerConfig ¶
type ServerConfig struct { // Placeholder for description of property def_port of obj type ServerConfig field type str type boolean DefPort *bool `json:"def_port,omitempty"` // hostname of ServerConfig. Hostname *string `json:"hostname,omitempty"` // Placeholder for description of property ip_addr of obj type ServerConfig field type str type object // Required: true IPAddr *IPAddr `json:"ip_addr"` // Placeholder for description of property is_enabled of obj type ServerConfig field type str type boolean // Required: true IsEnabled *bool `json:"is_enabled"` // Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL. LastState *string `json:"last_state,omitempty"` // VirtualService member in case this server is a member of GS group, and Geo Location available. Location *GeoLocation `json:"location,omitempty"` // Placeholder for description of property oper_status of obj type ServerConfig field type str type object OperStatus *OperationalStatus `json:"oper_status,omitempty"` // Number of port. // Required: true Port *int32 `json:"port"` // If this is set, propogate this server state to other SEs for this VS. Applicable to EastWest VS and GS HM-sharding. PropogateState *bool `json:"propogate_state,omitempty"` // Placeholder for description of property timer_exists of obj type ServerConfig field type str type boolean TimerExists *bool `json:"timer_exists,omitempty"` }
ServerConfig server config swagger:model ServerConfig
type ServerID ¶
type ServerID struct { // This is the external cloud uuid of the Pool server. ExternalUUID *string `json:"external_uuid,omitempty"` // Placeholder for description of property ip of obj type ServerId field type str type object // Required: true IP *IPAddr `json:"ip"` // Number of port. // Required: true Port *int32 `json:"port"` }
ServerID server Id swagger:model ServerId
type ServerScaleInParams ¶
type ServerScaleInParams struct { // Reason for the manual scalein. Reason *string `json:"reason,omitempty"` // List of server IDs that should be scaled in. Servers []*ServerID `json:"servers,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
ServerScaleInParams server scale in params swagger:model ServerScaleInParams
type ServerScaleOutParams ¶
type ServerScaleOutParams struct { // Reason for the manual scaleout. Reason *string `json:"reason,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
ServerScaleOutParams server scale out params swagger:model ServerScaleOutParams
type Service ¶
type Service struct { // Enable HTTP2 on this port. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableHttp2 *bool `json:"enable_http2,omitempty"` // Enable SSL termination and offload for traffic from clients. EnableSsl *bool `json:"enable_ssl,omitempty"` // Enable application layer specific features for the this specific service. It is a reference to an object of type ApplicationProfile. Field introduced in 17.2.4. Allowed in Basic edition, Essentials edition, Enterprise edition. OverrideApplicationProfileRef *string `json:"override_application_profile_ref,omitempty"` // Override the network profile for this specific service port. It is a reference to an object of type NetworkProfile. OverrideNetworkProfileRef *string `json:"override_network_profile_ref,omitempty"` // The Virtual Service's port number. Allowed values are 0-65535. // Required: true Port *int32 `json:"port"` // The end of the Virtual Service's port number range. Allowed values are 1-65535. Special values are 0- 'single port'. PortRangeEnd *int32 `json:"port_range_end,omitempty"` }
Service service swagger:model Service
type ServiceEngine ¶
type ServiceEngine struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // availability_zone of ServiceEngine. AvailabilityZone *string `json:"availability_zone,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // Placeholder for description of property container_mode of obj type ServiceEngine field type str type boolean ContainerMode *bool `json:"container_mode,omitempty"` // Enum options - CONTAINER_TYPE_BRIDGE, CONTAINER_TYPE_HOST, CONTAINER_TYPE_HOST_DPDK. ContainerType *string `json:"container_type,omitempty"` // Placeholder for description of property controller_created of obj type ServiceEngine field type str type boolean ControllerCreated *bool `json:"controller_created,omitempty"` // controller_ip of ServiceEngine. ControllerIP *string `json:"controller_ip,omitempty"` // Placeholder for description of property data_vnics of obj type ServiceEngine field type str type object DataVnics []*VNIC `json:"data_vnics,omitempty"` // inorder to disable SE set this field appropriately. Enum options - SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED, SE_STATE_DISABLED_FORCE. EnableState *string `json:"enable_state,omitempty"` // flavor of ServiceEngine. Flavor *string `json:"flavor,omitempty"` // It is a reference to an object of type VIMgrHostRuntime. HostRef *string `json:"host_ref,omitempty"` // Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Hypervisor *string `json:"hypervisor,omitempty"` // Placeholder for description of property mgmt_vnic of obj type ServiceEngine field type str type object MgmtVnic *VNIC `json:"mgmt_vnic,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Placeholder for description of property resources of obj type ServiceEngine field type str type object Resources *SeResources `json:"resources,omitempty"` // It is a reference to an object of type ServiceEngineGroup. SeGroupRef *string `json:"se_group_ref,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
ServiceEngine service engine swagger:model ServiceEngine
type ServiceEngineAPIResponse ¶
type ServiceEngineAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ServiceEngine `json:"results,omitempty"` }
ServiceEngineAPIResponse service engine Api response swagger:model ServiceEngineApiResponse
type ServiceEngineCloudLimits ¶
type ServiceEngineCloudLimits struct { // Cloud type for this cloud limit. Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Field introduced in 20.1.1. Type *string `json:"type,omitempty"` // Maximum number of vrfcontexts per serviceengine. Field introduced in 20.1.1. VrfsPerServiceengine *int32 `json:"vrfs_per_serviceengine,omitempty"` }
ServiceEngineCloudLimits service engine cloud limits swagger:model ServiceEngineCloudLimits
type ServiceEngineGroup ¶
type ServiceEngineGroup struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Enable accelerated networking option for Azure SE. Accelerated networking enables single root I/O virtualization (SR-IOV) to a SE VM. This improves networking performance. Field introduced in 17.2.14,18.1.5,18.2.1. AcceleratedNetworking *bool `json:"accelerated_networking,omitempty"` // Service Engines in active/standby mode for HA failover. ActiveStandby *bool `json:"active_standby,omitempty"` // Indicates the percent of config memory used for config updates. Allowed values are 0-90. Field deprecated in 18.1.2. Field introduced in 18.1.1. Unit is PERCENT. AdditionalConfigMemory *int32 `json:"additional_config_memory,omitempty"` // Advertise reach-ability of backend server networks via ADC through BGP for default gateway feature. Field deprecated in 18.2.5. AdvertiseBackendNetworks *bool `json:"advertise_backend_networks,omitempty"` // Enable aggressive failover configuration for ha. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AggressiveFailureDetection *bool `json:"aggressive_failure_detection,omitempty"` // In compact placement, Virtual Services are placed on existing SEs until max_vs_per_se limit is reached. Enum options - PLACEMENT_ALGO_PACKED, PLACEMENT_ALGO_DISTRIBUTED. Algo *string `json:"algo,omitempty"` // Allow SEs to be created using burst license. Field introduced in 17.2.5. AllowBurst *bool `json:"allow_burst,omitempty"` // A percent value of total SE memory reserved for applicationcaching. This is an SE bootup property and requires SE restart.Requires SE Reboot. Allowed values are 0 - 100. Special values are 0- 'disable'. Field introduced in 18.2.3. Unit is PERCENT. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Special default for Basic edition is 0, Essentials edition is 0, Enterprise is 10. AppCachePercent *int32 `json:"app_cache_percent,omitempty"` // The max memory that can be allocated for the app cache. This value will act as an upper bound on the cache size specified in app_cache_percent. Special values are 0- 'disable'. Field introduced in 20.1.1. Unit is GB. AppCacheThreshold *int32 `json:"app_cache_threshold,omitempty"` // A percent value of total SE memory reserved for Application learning. This is an SE bootup property and requires SE restart. Allowed values are 0 - 10. Field introduced in 18.2.3. Unit is PERCENT. AppLearningMemoryPercent *int32 `json:"app_learning_memory_percent,omitempty"` // Amount of SE memory in GB until which shared memory is collected in core archive. Field introduced in 17.1.3. Unit is GB. ArchiveShmLimit *int32 `json:"archive_shm_limit,omitempty"` // SSL handshakes will be handled by dedicated SSL Threads.Requires SE Reboot. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AsyncSsl *bool `json:"async_ssl,omitempty"` // Number of Async SSL threads per se_dp.Requires SE Reboot. Allowed values are 1-16. AsyncSslThreads *int32 `json:"async_ssl_threads,omitempty"` // If set, Virtual Services will be automatically migrated when load on an SE is less than minimum or more than maximum thresholds. Only Alerts are generated when the auto_rebalance is not set. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AutoRebalance *bool `json:"auto_rebalance,omitempty"` // Capacities of SE for auto rebalance for each criteria. Field introduced in 17.2.4. AutoRebalanceCapacityPerSe []int64 `json:"auto_rebalance_capacity_per_se,omitempty,omitempty"` // Set of criteria for SE Auto Rebalance. Enum options - SE_AUTO_REBALANCE_CPU, SE_AUTO_REBALANCE_PPS, SE_AUTO_REBALANCE_MBPS, SE_AUTO_REBALANCE_OPEN_CONNS, SE_AUTO_REBALANCE_CPS. Field introduced in 17.2.3. AutoRebalanceCriteria []string `json:"auto_rebalance_criteria,omitempty"` // Frequency of rebalance, if 'Auto rebalance' is enabled. Unit is SEC. AutoRebalanceInterval *int32 `json:"auto_rebalance_interval,omitempty"` // Redistribution of virtual services from the takeover SE to the replacement SE can cause momentary traffic loss. If the auto-redistribute load option is left in its default off state, any desired rebalancing requires calls to REST API. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AutoRedistributeActiveStandbyLoad *bool `json:"auto_redistribute_active_standby_load,omitempty"` // Availability zones for Virtual Service High Availability. It is a reference to an object of type AvailabilityZone. Field introduced in 20.1.1. AvailabilityZoneRefs []string `json:"availability_zone_refs,omitempty"` // BGP peer state update interval. Allowed values are 5-100. Field introduced in 17.2.14,18.1.5,18.2.1. Unit is SEC. BgpStateUpdateInterval *int32 `json:"bgp_state_update_interval,omitempty"` // Excess Service Engine capacity provisioned for HA failover. BufferSe *int32 `json:"buffer_se,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // Compress IP rules into a single subnet based IP rule for each north-south IPAM subnet configured in PCAP mode in OpenShift/Kubernetes node. Field introduced in 18.2.9, 20.1.1. CompressIPRulesForEachNsSubnet *bool `json:"compress_ip_rules_for_each_ns_subnet,omitempty"` // Enable config debugs on all cores of SE. Field introduced in 17.2.13,18.1.5,18.2.1. ConfigDebugsOnAllCores *bool `json:"config_debugs_on_all_cores,omitempty"` // Percentage of memory for connection state. This will come at the expense of memory used for HTTP in-memory cache. Allowed values are 10-90. Unit is PERCENT. ConnectionMemoryPercentage *int32 `json:"connection_memory_percentage,omitempty"` // Include shared memory for app cache in core file.Requires SE Reboot. Field introduced in 18.2.8, 20.1.1. CoreShmAppCache *bool `json:"core_shm_app_cache,omitempty"` // Include shared memory for app learning in core file.Requires SE Reboot. Field introduced in 18.2.8, 20.1.1. CoreShmAppLearning *bool `json:"core_shm_app_learning,omitempty"` // Placeholder for description of property cpu_reserve of obj type ServiceEngineGroup field type str type boolean CPUReserve *bool `json:"cpu_reserve,omitempty"` // Allocate all the CPU cores for the Service Engine Virtual Machines on the same CPU socket. Applicable only for vCenter Cloud. CPUSocketAffinity *bool `json:"cpu_socket_affinity,omitempty"` // Custom Security Groups to be associated with data vNics for SE instances in OpenStack and AWS Clouds. Field introduced in 17.1.3. CustomSecuritygroupsData []string `json:"custom_securitygroups_data,omitempty"` // Custom Security Groups to be associated with management vNic for SE instances in OpenStack and AWS Clouds. Field introduced in 17.1.3. CustomSecuritygroupsMgmt []string `json:"custom_securitygroups_mgmt,omitempty"` // Custom tag will be used to create the tags for SE instance in AWS. Note this is not the same as the prefix for SE name. CustomTag []*CustomTag `json:"custom_tag,omitempty"` // Subnet used to spin up the data nic for Service Engines, used only for Azure cloud. Overrides the cloud level setting for Service Engine subnet. Field introduced in 18.2.3. DataNetworkID *string `json:"data_network_id,omitempty"` // Number of instructions before datascript times out. Allowed values are 0-100000000. Field introduced in 18.2.3. DatascriptTimeout *int64 `json:"datascript_timeout,omitempty"` // Dedicate the core that handles packet receive/transmit from the network to just the dispatching function. Don't use it for TCP/IP and SSL functions. DedicatedDispatcherCore *bool `json:"dedicated_dispatcher_core,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // By default, Avi creates and manages security groups along with custom sg provided by user. Set this to True to disallow Avi to create and manage new security groups. Avi will only make use of custom security groups provided by user. This option is supported for AWS and OpenStack cloud types. Field introduced in 17.2.13,18.1.4,18.2.1. DisableAviSecuritygroups *bool `json:"disable_avi_securitygroups,omitempty"` // Stop using TCP/UDP and IP checksum offload features of NICs. Field introduced in 17.1.14, 17.2.5, 18.1.1. DisableCsumOffloads *bool `json:"disable_csum_offloads,omitempty"` // Disable Flow Probes for Scaled out VS'es. Field introduced in 20.1.3. DisableFlowProbes *bool `json:"disable_flow_probes,omitempty"` // Disable Generic Receive Offload (GRO) in DPDK poll-mode driver packet receive path. GRO is on by default on NICs that do not support LRO (Large Receive Offload) or do not gain performance boost from LRO. Field introduced in 17.2.5, 18.1.1. DisableGro *bool `json:"disable_gro,omitempty"` // If set, disable the config memory check done in service engine. Field introduced in 18.1.2. DisableSeMemoryCheck *bool `json:"disable_se_memory_check,omitempty"` // Disable TCP Segmentation Offload (TSO) in DPDK poll-mode driver packet transmit path. TSO is on by default on NICs that support it. Field introduced in 17.2.5, 18.1.1. DisableTso *bool `json:"disable_tso,omitempty"` // Amount of disk space for each of the Service Engine virtual machines. Unit is GB. DiskPerSe *int32 `json:"disk_per_se,omitempty"` // Use both the active and standby Service Engines for Virtual Service placement in the legacy active standby HA mode. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. DistributeLoadActiveStandby *bool `json:"distribute_load_active_standby,omitempty"` // Distributes queue ownership among cores so multiple cores handle dispatcher duties. Requires SE Reboot. Deprecated from 18.2.8, instead use max_queues_per_vnic. Field introduced in 17.2.8. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. DistributeQueues *bool `json:"distribute_queues,omitempty"` // Distributes vnic ownership among cores so multiple cores handle dispatcher duties.Requires SE Reboot. Field introduced in 18.2.5. DistributeVnics *bool `json:"distribute_vnics,omitempty"` // Dequeue interval for receive queue from se_dp in aggressive mode. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is MILLISECONDS. DpAggressiveDeqIntervalMsec *int32 `json:"dp_aggressive_deq_interval_msec,omitempty"` // Enqueue interval for request queue to se_dp in aggressive mode. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is MILLISECONDS. DpAggressiveEnqIntervalMsec *int32 `json:"dp_aggressive_enq_interval_msec,omitempty"` // Frequency of SE - SE HB messages when aggressive failure mode detection is enabled. Field introduced in 20.1.3. Unit is MILLISECONDS. DpAggressiveHbFrequency *int32 `json:"dp_aggressive_hb_frequency,omitempty"` // Consecutive HB failures after which failure is reported to controller,when aggressive failure mode detection is enabled. Field introduced in 20.1.3. DpAggressiveHbTimeoutCount *int32 `json:"dp_aggressive_hb_timeout_count,omitempty"` // Dequeue interval for receive queue from se_dp. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is MILLISECONDS. DpDeqIntervalMsec *int32 `json:"dp_deq_interval_msec,omitempty"` // Enqueue interval for request queue to se_dp. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is MILLISECONDS. DpEnqIntervalMsec *int32 `json:"dp_enq_interval_msec,omitempty"` // Frequency of SE - SE HB messages when aggressive failure mode detection is not enabled. Field introduced in 20.1.3. Unit is MILLISECONDS. DpHbFrequency *int32 `json:"dp_hb_frequency,omitempty"` // Consecutive HB failures after which failure is reported to controller, when aggressive failure mode detection is not enabled. Field introduced in 20.1.3. DpHbTimeoutCount *int32 `json:"dp_hb_timeout_count,omitempty"` // Enable GratArp for VIP_IP. Field introduced in 18.2.3. EnableGratarpPermanent *bool `json:"enable_gratarp_permanent,omitempty"` // (This is a beta feature). Enable HSM key priming. If enabled, key handles on the hsm will be synced to SE before processing client connections. Field introduced in 17.2.7, 18.1.1. EnableHsmPriming *bool `json:"enable_hsm_priming,omitempty"` // Applicable only for Azure cloud with Basic SKU LB. If set, additional Azure LBs will be automatically created if resources in existing LB are exhausted. Field introduced in 17.2.10, 18.1.2. EnableMultiLb *bool `json:"enable_multi_lb,omitempty"` // Enable TX ring support in pcap mode of operation. TSO feature is not supported with TX Ring enabled. Deprecated from 18.2.8, instead use pcap_tx_mode. Requires SE Reboot. Field introduced in 18.2.5. EnablePcapTxRing *bool `json:"enable_pcap_tx_ring,omitempty"` // Enable routing for this ServiceEngineGroup . Field deprecated in 18.2.5. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableRouting *bool `json:"enable_routing,omitempty"` // Enable VIP on all interfaces of SE. Field deprecated in 18.2.5. Field introduced in 17.1.1. EnableVipOnAllInterfaces *bool `json:"enable_vip_on_all_interfaces,omitempty"` // Use Virtual MAC address for interfaces on which floating interface IPs are placed. Field deprecated in 18.2.5. EnableVMAC *bool `json:"enable_vmac,omitempty"` // End local ephemeral port number for outbound connections. Field introduced in 17.2.13, 18.1.5, 18.2.1. EphemeralPortrangeEnd *int32 `json:"ephemeral_portrange_end,omitempty"` // Start local ephemeral port number for outbound connections. Field introduced in 17.2.13, 18.1.5, 18.2.1. EphemeralPortrangeStart *int32 `json:"ephemeral_portrange_start,omitempty"` // Multiplier for extra config to support large VS/Pool config. ExtraConfigMultiplier *float64 `json:"extra_config_multiplier,omitempty"` ExtraSharedConfigMemory *int32 `json:"extra_shared_config_memory,omitempty"` // If ServiceEngineGroup is configured for Legacy 1+1 Active Standby HA Mode, Floating IP's will be advertised only by the Active SE in the Pair. Virtual Services in this group must be disabled/enabled for any changes to the Floating IP's to take effect. Only active SE hosting VS tagged with Active Standby SE 1 Tag will advertise this floating IP when manual load distribution is enabled. Field deprecated in 18.2.5. Maximum of 32 items allowed. FloatingIntfIP []*IPAddr `json:"floating_intf_ip,omitempty"` // If ServiceEngineGroup is configured for Legacy 1+1 Active Standby HA Mode, Floating IP's will be advertised only by the Active SE in the Pair. Virtual Services in this group must be disabled/enabled for any changes to the Floating IP's to take effect. Only active SE hosting VS tagged with Active Standby SE 2 Tag will advertise this floating IP when manual load distribution is enabled. Field deprecated in 18.2.5. Maximum of 32 items allowed. FloatingIntfIPSe2 []*IPAddr `json:"floating_intf_ip_se_2,omitempty"` // Maximum number of flow table entries that have not completed TCP three-way handshake yet. Field introduced in 17.2.5. FlowTableNewSynMaxEntries *int32 `json:"flow_table_new_syn_max_entries,omitempty"` // Number of entries in the free list. Field introduced in 17.2.10, 18.1.2. FreeListSize *int32 `json:"free_list_size,omitempty"` // Google Cloud Platform, Service Engine Group Configuration. Field introduced in 20.1.3. GcpConfig *GCPSeGroupConfig `json:"gcp_config,omitempty"` // GratArp periodicity for VIP-IP. Allowed values are 5-30. Field introduced in 18.2.3. Unit is MIN. GratarpPermanentPeriodicity *int32 `json:"gratarp_permanent_periodicity,omitempty"` // High Availability mode for all the Virtual Services using this Service Engine group. Enum options - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY. Allowed in Basic(Allowed values- HA_MODE_LEGACY_ACTIVE_STANDBY) edition, Essentials(Allowed values- HA_MODE_LEGACY_ACTIVE_STANDBY) edition, Enterprise edition. Special default for Basic edition is HA_MODE_LEGACY_ACTIVE_STANDBY, Essentials edition is HA_MODE_LEGACY_ACTIVE_STANDBY, Enterprise is HA_MODE_SHARED. HaMode *string `json:"ha_mode,omitempty"` // Configuration to handle per packet attack handling.For example, DNS Reflection Attack is a type of attack where a response packet is sent to the DNS VS.This configuration tells if such packets should be dropped without further processing. Field introduced in 20.1.3. HandlePerPktAttack *bool `json:"handle_per_pkt_attack,omitempty"` // It is a reference to an object of type HardwareSecurityModuleGroup. HardwaresecuritymodulegroupRef *string `json:"hardwaresecuritymodulegroup_ref,omitempty"` // Minimum required heap memory to apply any configuration. Allowed values are 0-100. Field introduced in 18.1.2. Unit is MB. HeapMinimumConfigMemory *int32 `json:"heap_minimum_config_memory,omitempty"` // Enable active health monitoring from the standby SE for all placed virtual services. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. HmOnStandby *bool `json:"hm_on_standby,omitempty"` // Key of a (Key, Value) pair identifying a label for a set of Nodes usually in Container Clouds. Needs to be specified together with host_attribute_value. SEs can be configured differently including HA modes across different SE Groups. May also be used for isolation between different classes of VirtualServices. VirtualServices' SE Group may be specified via annotations/labels. A OpenShift/Kubernetes namespace maybe annotated with a matching SE Group label as openshift.io/node-selector apptype=prod. When multiple SE Groups are used in a Cloud with host attributes specified,just a single SE Group can exist as a match-all SE Group without a host_attribute_key. HostAttributeKey *string `json:"host_attribute_key,omitempty"` // Value of a (Key, Value) pair identifying a label for a set of Nodes usually in Container Clouds. Needs to be specified together with host_attribute_key. HostAttributeValue *string `json:"host_attribute_value,omitempty"` // Enable the host gateway monitor when service engine is deployed as docker container. Disabled by default. Field introduced in 17.2.4. HostGatewayMonitor *bool `json:"host_gateway_monitor,omitempty"` // Override default hypervisor. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Hypervisor *string `json:"hypervisor,omitempty"` // Ignore RTT samples if it is above threshold. Field introduced in 17.1.6,17.2.2. Unit is MILLISECONDS. IgnoreRttThreshold *int32 `json:"ignore_rtt_threshold,omitempty"` // Program SE security group ingress rules to allow VIP data access from remote CIDR type. Enum options - SG_INGRESS_ACCESS_NONE, SG_INGRESS_ACCESS_ALL, SG_INGRESS_ACCESS_VPC. Field introduced in 17.1.5. IngressAccessData *string `json:"ingress_access_data,omitempty"` // Program SE security group ingress rules to allow SSH/ICMP management access from remote CIDR type. Enum options - SG_INGRESS_ACCESS_NONE, SG_INGRESS_ACCESS_ALL, SG_INGRESS_ACCESS_VPC. Field introduced in 17.1.5. IngressAccessMgmt *string `json:"ingress_access_mgmt,omitempty"` // Instance/Flavor name for SE instance. InstanceFlavor *string `json:"instance_flavor,omitempty"` // Additional information associated with instance_flavor. Field introduced in 20.1.1. InstanceFlavorInfo *CloudFlavor `json:"instance_flavor_info,omitempty"` // Iptable Rules. Maximum of 128 items allowed. Iptables []*IptableRuleSet `json:"iptables,omitempty"` // Labels associated with this SE group. Field introduced in 20.1.1. Maximum of 1 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Select core with least load for new flow. LeastLoadCoreSelection *bool `json:"least_load_core_selection,omitempty"` // Specifies the license tier which would be used. This field by default inherits the value from cloud. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS. Field introduced in 17.2.5. LicenseTier *string `json:"license_tier,omitempty"` // If no license type is specified then default license enforcement for the cloud type is chosen. Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH. Field introduced in 17.2.5. LicenseType *string `json:"license_type,omitempty"` // Maximum disk capacity (in MB) to be allocated to an SE. This is exclusively used for debug and log data. Unit is MB. LogDisksz *int32 `json:"log_disksz,omitempty"` // SE will log memory allocation related failure to the se_trace file, wherever available. Field introduced in 20.1.2. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. LogMallocFailure *bool `json:"log_malloc_failure,omitempty"` // Maximum number of external health monitors that can run concurrently in a service engine. This helps control the CPU and memory use by external health monitors. Special values are 0- 'Value will be internally calculated based on cpu and memory'. Field introduced in 18.2.7. MaxConcurrentExternalHm *int32 `json:"max_concurrent_external_hm,omitempty"` // When CPU usage on an SE exceeds this threshold, Virtual Services hosted on this SE may be rebalanced to other SEs to reduce load. A new SE may be created as part of this process. Allowed values are 40-90. Unit is PERCENT. MaxCPUUsage *int32 `json:"max_cpu_usage,omitempty"` // Max bytes that can be allocated in a single mempool. Field introduced in 18.1.5. Unit is MB. MaxMemoryPerMempool *int32 `json:"max_memory_per_mempool,omitempty"` // Configures the maximum number of se_dp processes created on the SE, requires SE reboot. If not configured, defaults to the number of CPUs on the SE. This should only be used if user wants to limit the number of se_dps to less than the available CPUs on the SE. Allowed values are 1-128. Field introduced in 20.1.1. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. MaxNumSeDps *int32 `json:"max_num_se_dps,omitempty"` // Applicable to Azure platform only. Maximum number of public IPs per Azure LB. . Field introduced in 17.2.12, 18.1.2. MaxPublicIpsPerLb *int32 `json:"max_public_ips_per_lb,omitempty"` // Maximum number of queues per vnic Setting to '0' utilises all queues that are distributed across dispatcher cores. Allowed values are 0,1,2,4,8,16. Field introduced in 18.2.7, 20.1.1. MaxQueuesPerVnic *int32 `json:"max_queues_per_vnic,omitempty"` // Applicable to Azure platform only. Maximum number of rules per Azure LB. . Field introduced in 17.2.12, 18.1.2. MaxRulesPerLb *int32 `json:"max_rules_per_lb,omitempty"` // Maximum number of active Service Engines for the Virtual Service. Allowed values are 1-64. MaxScaleoutPerVs *int32 `json:"max_scaleout_per_vs,omitempty"` // Maximum number of Services Engines in this group. Allowed values are 0-1000. MaxSe *int32 `json:"max_se,omitempty"` // Maximum number of Virtual Services that can be placed on a single Service Engine. Allowed values are 1-1000. MaxVsPerSe *int32 `json:"max_vs_per_se,omitempty"` // Placeholder for description of property mem_reserve of obj type ServiceEngineGroup field type str type boolean MemReserve *bool `json:"mem_reserve,omitempty"` // Indicates the percent of memory reserved for config updates. Allowed values are 0-100. Field introduced in 18.1.2. Unit is PERCENT. MemoryForConfigUpdate *int32 `json:"memory_for_config_update,omitempty"` // Amount of memory for each of the Service Engine virtual machines. Changes to this setting do not affect existing SEs. MemoryPerSe *int32 `json:"memory_per_se,omitempty"` // Management network to use for Avi Service Engines. It is a reference to an object of type Network. MgmtNetworkRef *string `json:"mgmt_network_ref,omitempty"` // Management subnet to use for Avi Service Engines. MgmtSubnet *IPAddrPrefix `json:"mgmt_subnet,omitempty"` // When CPU usage on an SE falls below the minimum threshold, Virtual Services hosted on the SE may be consolidated onto other underutilized SEs. After consolidation, unused Service Engines may then be eligible for deletion. . Allowed values are 20-60. Unit is PERCENT. MinCPUUsage *int32 `json:"min_cpu_usage,omitempty"` // Minimum number of active Service Engines for the Virtual Service. Allowed values are 1-64. MinScaleoutPerVs *int32 `json:"min_scaleout_per_vs,omitempty"` // Minimum number of Services Engines in this group (relevant for SE AutoRebalance only). Allowed values are 0-1000. Field introduced in 17.2.13,18.1.3,18.2.1. MinSe *int32 `json:"min_se,omitempty"` // Indicates the percent of memory reserved for connections. Allowed values are 0-100. Field introduced in 18.1.2. Unit is PERCENT. MinimumConnectionMemory *int32 `json:"minimum_connection_memory,omitempty"` // Required available config memory to apply any configuration. Allowed values are 0-90. Field deprecated in 18.1.2. Field introduced in 18.1.1. Unit is PERCENT. MinimumRequiredConfigMemory *int32 `json:"minimum_required_config_memory,omitempty"` // Number of threads to use for log streaming. Allowed values are 1-100. Field introduced in 17.2.12, 18.1.2. NLogStreamingThreads *int32 `json:"n_log_streaming_threads,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Idle timeout in seconds for nat tcp flows in closed state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. NatFlowTCPClosedTimeout *int32 `json:"nat_flow_tcp_closed_timeout,omitempty"` // Idle timeout in seconds for nat tcp flows in established state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. NatFlowTCPEstablishedTimeout *int32 `json:"nat_flow_tcp_established_timeout,omitempty"` // Idle timeout in seconds for nat tcp flows in half closed state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. NatFlowTCPHalfClosedTimeout *int32 `json:"nat_flow_tcp_half_closed_timeout,omitempty"` // Idle timeout in seconds for nat tcp flows in handshake state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. NatFlowTCPHandshakeTimeout *int32 `json:"nat_flow_tcp_handshake_timeout,omitempty"` // Idle timeout in seconds for nat udp flows in noresponse state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. NatFlowUDPNoresponseTimeout *int32 `json:"nat_flow_udp_noresponse_timeout,omitempty"` // Idle timeout in seconds for nat udp flows in response state. Allowed values are 1-3600. Field deprecated in 18.2.5. Field introduced in 18.2.5. Unit is SECONDS. NatFlowUDPResponseTimeout *int32 `json:"nat_flow_udp_response_timeout,omitempty"` // Number of threads to poll for netlink messages excluding the thread for default namespace. Requires SE Reboot. Allowed values are 1-32. Field introduced in 20.1.3. NetlinkPollerThreads *int32 `json:"netlink_poller_threads,omitempty"` // Socket buffer size for the netlink sockets. Requires SE Reboot. Allowed values are 1-128. Field introduced in 20.1.3. Unit is MEGA_BYTES. NetlinkSockBufSize *int32 `json:"netlink_sock_buf_size,omitempty"` // This setting limits the number of non-significant logs generated per second per core on this SE. Default is 100 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. NonSignificantLogThrottle *int32 `json:"non_significant_log_throttle,omitempty"` // Dequeue interval for receive queue from NS HELPER. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is MILLISECONDS. NsHelperDeqIntervalMsec *int32 `json:"ns_helper_deq_interval_msec,omitempty"` // Number of dispatcher cores (0,1,2,4,8 or 16). If set to 0, then number of dispatcher cores is deduced automatically.Requires SE Reboot. Allowed values are 0,1,2,4,8,16. Field introduced in 17.2.12, 18.1.3, 18.2.1. NumDispatcherCores *int32 `json:"num_dispatcher_cores,omitempty"` // Number of changes in num flow cores sum to ignore. NumFlowCoresSumChangesToIgnore *int32 `json:"num_flow_cores_sum_changes_to_ignore,omitempty"` // Configuration knobs for InterSE Object Distribution. Field introduced in 20.1.3. ObjsyncConfig *ObjSyncConfig `json:"objsync_config,omitempty"` // TCP port on SE management interface for InterSE Object Distribution. Supported only for externally managed security groups. Not supported on full access deployments. Requires SE reboot. Field introduced in 20.1.3. ObjsyncPort *int32 `json:"objsync_port,omitempty"` // Field deprecated in 17.1.1. OpenstackAvailabilityZone *string `json:"openstack_availability_zone,omitempty"` // Field introduced in 17.1.1. Maximum of 5 items allowed. OpenstackAvailabilityZones []string `json:"openstack_availability_zones,omitempty"` // Avi Management network name. OpenstackMgmtNetworkName *string `json:"openstack_mgmt_network_name,omitempty"` // Management network UUID. OpenstackMgmtNetworkUUID *string `json:"openstack_mgmt_network_uuid,omitempty"` // Amount of extra memory to be reserved for use by the Operating System on a Service Engine. Unit is MB. OsReservedMemory *int32 `json:"os_reserved_memory,omitempty"` // Determines the PCAP transmit mode of operation. Requires SE Reboot. Enum options - PCAP_TX_AUTO, PCAP_TX_SOCKET, PCAP_TX_RING. Field introduced in 18.2.8, 20.1.1. PcapTxMode *string `json:"pcap_tx_mode,omitempty"` // In PCAP mode, reserve a configured portion of TX ring resources for itself and the remaining portion for the RX ring to achieve better balance in terms of queue depth. Requires SE Reboot. Allowed values are 10-100. Field introduced in 20.1.3. Unit is PERCENT. PcapTxRingRdBalancingFactor *int32 `json:"pcap_tx_ring_rd_balancing_factor,omitempty"` // Per-app SE mode is designed for deploying dedicated load balancers per app (VS). In this mode, each SE is limited to a max of 2 VSs. vCPUs in per-app SEs count towards licensing usage at 25% rate. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. PerApp *bool `json:"per_app,omitempty"` // Enable/Disable per VS level admission control.Enabling this feature will cause the connection and packet throttling on a particular VS that has high packet buffer consumption. Field introduced in 20.1.3. PerVsAdmissionControl *bool `json:"per_vs_admission_control,omitempty"` // If placement mode is 'Auto', Virtual Services are automatically placed on Service Engines. Enum options - PLACEMENT_MODE_AUTO. PlacementMode *string `json:"placement_mode,omitempty"` // Enable or deactivate real time SE metrics. RealtimeSeMetrics *MetricsRealTimeUpdate `json:"realtime_se_metrics,omitempty"` // Reboot the VM or host on kernel panic. Field introduced in 18.2.5. RebootOnPanic *bool `json:"reboot_on_panic,omitempty"` // Reboot the system if the SE is stopped. Field deprecated in 18.2.5. RebootOnStop *bool `json:"reboot_on_stop,omitempty"` // Time interval to re-sync SE's time with wall clock time. Allowed values are 8-600000. Field introduced in 20.1.1. Unit is MILLISECONDS. ResyncTimeInterval *int32 `json:"resync_time_interval,omitempty"` // Select the SE bandwidth for the bandwidth license. Enum options - SE_BANDWIDTH_UNLIMITED, SE_BANDWIDTH_25M, SE_BANDWIDTH_200M, SE_BANDWIDTH_1000M, SE_BANDWIDTH_10000M. Field introduced in 17.2.5. Allowed in Basic(Allowed values- SE_BANDWIDTH_UNLIMITED) edition, Essentials(Allowed values- SE_BANDWIDTH_UNLIMITED) edition, Enterprise edition. SeBandwidthType *string `json:"se_bandwidth_type,omitempty"` // Delay the cleanup of flowtable entry. To be used under surveillance of Avi Support. Field introduced in 20.1.2. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. SeDelayedFlowDelete *bool `json:"se_delayed_flow_delete,omitempty"` // Duration to preserve unused Service Engine virtual machines before deleting them. If traffic to a Virtual Service were to spike up abruptly, this SE would still be available to be utilized again rather than creating a new SE. If this value is set to 0, Controller will never delete any SEs and administrator has to manually cleanup unused SEs. Allowed values are 0-525600. Unit is MIN. SeDeprovisionDelay *int32 `json:"se_deprovision_delay,omitempty"` // Placeholder for description of property se_dos_profile of obj type ServiceEngineGroup field type str type object SeDosProfile *DosThresholdProfile `json:"se_dos_profile,omitempty"` // Internal only. Used to simulate SE - SE HB failure. Field introduced in 20.1.3. SeDpHmDrops *int32 `json:"se_dp_hm_drops,omitempty"` // Toggle support to run SE datapath instances in isolation on exclusive CPUs. This improves latency and performance. However, this could reduce the total number of se_dp instances created on that SE instance. Supported for >= 8 CPUs. Requires SE reboot. Field introduced in 20.1.4. SeDpIsolation *bool `json:"se_dp_isolation,omitempty"` // Number of CPUs for non se-dp tasks in SE datapath isolation mode. Translates Total cpus minus 'num_non_dp_cpus' for datapath use.Requires SE reboot. Allowed values are 1-8. Special values are 0- 'auto'. Field introduced in 20.1.4. SeDpIsolationNumNonDpCpus *int32 `json:"se_dp_isolation_num_non_dp_cpus,omitempty"` // The highest supported SE-SE Heartbeat protocol version. This version is reported by Secondary SE to Primary SE in Heartbeat response messages. Allowed values are 1-2. Field introduced in 20.1.1. SeDpMaxHbVersion *int32 `json:"se_dp_max_hb_version,omitempty"` // Time (in seconds) service engine waits for after generating a Vnic transmit queue stall event before resetting theNIC. Field introduced in 18.2.5. SeDpVnicQueueStallEventSleep *int32 `json:"se_dp_vnic_queue_stall_event_sleep,omitempty"` // Number of consecutive transmit failures to look for before generating a Vnic transmit queue stall event. Field introduced in 18.2.5. SeDpVnicQueueStallThreshold *int32 `json:"se_dp_vnic_queue_stall_threshold,omitempty"` // Time (in milliseconds) to wait for network/NIC recovery on detecting a transmit queue stall after which service engine resets the NIC. Field introduced in 18.2.5. SeDpVnicQueueStallTimeout *int32 `json:"se_dp_vnic_queue_stall_timeout,omitempty"` // Number of consecutive transmit queue stall events in se_dp_vnic_stall_se_restart_window to look for before restarting SE. Field introduced in 18.2.5. SeDpVnicRestartOnQueueStallCount *int32 `json:"se_dp_vnic_restart_on_queue_stall_count,omitempty"` // Window of time (in seconds) during which se_dp_vnic_restart_on_queue_stall_count number of consecutive stalls results in a SE restart. Field introduced in 18.2.5. SeDpVnicStallSeRestartWindow *int32 `json:"se_dp_vnic_stall_se_restart_window,omitempty"` // Determines if DPDK pool mode driver should be used or not 0 Automatically determine based on hypervisor/NIC type 1 Unconditionally use DPDK poll mode driver 2 Don't use DPDK poll mode driver.Requires SE Reboot. Allowed values are 0-2. Field introduced in 18.1.3. SeDpdkPmd *int32 `json:"se_dpdk_pmd,omitempty"` // Flow probe retry count if no replies are received.Requires SE Reboot. Allowed values are 0-5. Field introduced in 18.1.4, 18.2.1. SeFlowProbeRetries *int32 `json:"se_flow_probe_retries,omitempty"` // Timeout in milliseconds for flow probe retries.Requires SE Reboot. Allowed values are 20-50. Field introduced in 18.2.5. Unit is MILLISECONDS. SeFlowProbeRetryTimer *int32 `json:"se_flow_probe_retry_timer,omitempty"` // Timeout in milliseconds for flow probe entries. Allowed values are 10-200. Field deprecated in 18.2.5. Field introduced in 18.1.4, 18.2.1. Unit is MILLISECONDS. SeFlowProbeTimer *int32 `json:"se_flow_probe_timer,omitempty"` // Analytics Policy for ServiceEngineGroup. Field introduced in 20.1.3. SeGroupAnalyticsPolicy *SeGroupAnalyticsPolicy `json:"se_group_analytics_policy,omitempty"` // Controls the distribution of SE data path processes on CPUs which support hyper-threading. Requires hyper-threading to be enabled at host level. Requires SE Reboot. For more details please refer to SE placement KB. Enum options - SE_CPU_HT_AUTO, SE_CPU_HT_SPARSE_DISPATCHER_PRIORITY, SE_CPU_HT_SPARSE_PROXY_PRIORITY, SE_CPU_HT_PACKED_CORES. Field introduced in 20.1.1. SeHyperthreadedMode *string `json:"se_hyperthreaded_mode,omitempty"` // Determines if SE-SE IPC messages are encapsulated in an IP header 0 Automatically determine based on hypervisor type 1 Use IP encap unconditionally ~[0,1] Don't use IP encapRequires SE Reboot. Field introduced in 20.1.3. SeIPEncapIpc *int32 `json:"se_ip_encap_ipc,omitempty"` // UDP Port for SE_DP IPC in Docker bridge mode. Field deprecated in 20.1.1. Field introduced in 17.1.2. SeIpcUDPPort *int32 `json:"se_ipc_udp_port,omitempty"` // This knob controls the resource availability and burst size used between SE datapath and KNI. This helps in minimising packet drops when there is higher KNI traffic (non-VIP traffic from and to Linux). The factor takes the following values 0-default. 1-doubles the burst size and KNI resources. 2-quadruples the burst size and KNI resources. Allowed values are 0-2. Field introduced in 18.2.6. SeKniBurstFactor *int32 `json:"se_kni_burst_factor,omitempty"` // Determines if SE-SE IPC messages use SE interface IP instead of VIP 0 Automatically determine based on hypervisor type 1 Use SE interface IP unconditionally ~[0,1] Don't use SE interface IPRequires SE Reboot. Field introduced in 20.1.3. SeL3EncapIpc *int32 `json:"se_l3_encap_ipc,omitempty"` // Enable or disable Large Receive Optimization for vnics. Requires SE Reboot. Field introduced in 18.2.5. SeLro *bool `json:"se_lro,omitempty"` // The retry count for the multi-producer enqueue before yielding the CPU. To be used under surveillance of Avi Support. Field introduced in 20.1.3. Allowed in Basic(Allowed values- 500) edition, Essentials(Allowed values- 500) edition, Enterprise edition. SeMpRingRetryCount *int32 `json:"se_mp_ring_retry_count,omitempty"` // MTU for the VNICs of SEs in the SE group. Allowed values are 512-9000. Field introduced in 18.2.8, 20.1.1. SeMtu *int32 `json:"se_mtu,omitempty"` // Prefix to use for virtual machine name of Service Engines. SeNamePrefix *string `json:"se_name_prefix,omitempty"` // Enables lookahead mode of packet receive in PCAP mode. Introduced to overcome an issue with hv_netvsc driver. Lookahead mode attempts to ensure that application and kernel's view of the receive rings are consistent. Field introduced in 18.2.3. SePcapLookahead *bool `json:"se_pcap_lookahead,omitempty"` // Max number of packets the pcap interface can hold and if the value is 0 the optimum value will be chosen. The optimum value will be chosen based on SE-memory, Cloud Type and Number of Interfaces.Requires SE Reboot. Field introduced in 18.2.5. SePcapPktCount *int32 `json:"se_pcap_pkt_count,omitempty"` // Max size of each packet in the pcap interface. Requires SE Reboot. Field introduced in 18.2.5. SePcapPktSz *int32 `json:"se_pcap_pkt_sz,omitempty"` // Bypass the kernel's traffic control layer, to deliver packets directly to the driver. Enabling this feature results in egress packets not being captured in host tcpdump. Note brief packet reordering or loss may occur upon toggle. Field introduced in 18.2.6. SePcapQdiscBypass *bool `json:"se_pcap_qdisc_bypass,omitempty"` // Frequency in seconds at which periodically a PCAP reinit check is triggered. May be used in conjunction with the configuration pcap_reinit_threshold. (Valid range 15 mins - 12 hours, 0 - disables). Allowed values are 900-43200. Special values are 0- 'disable'. Field introduced in 17.2.13, 18.1.3, 18.2.1. Unit is SEC. SePcapReinitFrequency *int32 `json:"se_pcap_reinit_frequency,omitempty"` // Threshold for input packet receive errors in PCAP mode exceeding which a PCAP reinit is triggered. If not set, an unconditional reinit is performed. This value is checked every pcap_reinit_frequency interval. Field introduced in 17.2.13, 18.1.3, 18.2.1. Unit is METRIC_COUNT. SePcapReinitThreshold *int32 `json:"se_pcap_reinit_threshold,omitempty"` // TCP port on SE where echo service will be run. Field introduced in 17.2.2. SeProbePort *int32 `json:"se_probe_port,omitempty"` // UDP Port for punted packets in Docker bridge mode. Field deprecated in 20.1.1. Field introduced in 17.1.2. SeRemotePuntUDPPort *int32 `json:"se_remote_punt_udp_port,omitempty"` // Rate limiter properties. Field introduced in 20.1.1. SeRlProp *RateLimiterProperties `json:"se_rl_prop,omitempty"` // Enable routing via Service Engine Datapath. When disabled, routing is done by the Linux kernel. IP Routing needs to be enabled in Service Engine Group for SE Routing to be effective. Field deprecated in 18.2.5. Field introduced in 18.2.3. SeRouting *bool `json:"se_routing,omitempty"` SeRumSamplingNavInterval *int32 `json:"se_rum_sampling_nav_interval,omitempty"` SeRumSamplingNavPercent *int32 `json:"se_rum_sampling_nav_percent,omitempty"` // Minimum time to wait on server between taking sampleswhen sampling the resource timing data from the end user client. Field introduced in 18.2.6. Unit is SEC. SeRumSamplingResInterval *int32 `json:"se_rum_sampling_res_interval,omitempty"` // Percentage of resource timing data from the end user client used for sampling to get client insight. Field introduced in 18.2.6. SeRumSamplingResPercent *int32 `json:"se_rum_sampling_res_percent,omitempty"` // Sideband traffic will be handled by a dedicated core.Requires SE Reboot. Field introduced in 16.5.2, 17.1.9, 17.2.3. SeSbDedicatedCore *bool `json:"se_sb_dedicated_core,omitempty"` // Number of Sideband threads per SE.Requires SE Reboot. Allowed values are 1-128. Field introduced in 16.5.2, 17.1.9, 17.2.3. SeSbThreads *int32 `json:"se_sb_threads,omitempty"` // Multiplier for SE threads based on vCPU. Allowed values are 1-10. Allowed in Basic(Allowed values- 1) edition, Essentials(Allowed values- 1) edition, Enterprise edition. SeThreadMultiplier *int32 `json:"se_thread_multiplier,omitempty"` // Traceroute port range. Field introduced in 17.2.8. SeTracertPortRange *PortRange `json:"se_tracert_port_range,omitempty"` // Determines if Direct Secondary Return (DSR) from secondary SE is active or not 0 Automatically determine based on hypervisor type. 1 Enable tunnel mode - DSR is unconditionally disabled. 2 Disable tunnel mode - DSR is unconditionally enabled. Tunnel mode can be enabled or disabled at run-time. Allowed values are 0-2. Field introduced in 17.1.1. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. SeTunnelMode *int32 `json:"se_tunnel_mode,omitempty"` // UDP Port for tunneled packets from secondary to primary SE in Docker bridge mode.Requires SE Reboot. Field introduced in 17.1.3. SeTunnelUDPPort *int32 `json:"se_tunnel_udp_port,omitempty"` // Number of packets to batch for transmit to the nic. Requires SE Reboot. Field introduced in 18.2.5. SeTxBatchSize *int32 `json:"se_tx_batch_size,omitempty"` // Once the TX queue of the dispatcher reaches this threshold, hardware queues are not polled for further packets. To be used under surveillance of Avi Support. Allowed values are 512-32768. Field introduced in 20.1.2. Allowed in Basic(Allowed values- 2048) edition, Essentials(Allowed values- 2048) edition, Enterprise edition. SeTxqThreshold *int32 `json:"se_txq_threshold,omitempty"` // Determines if SE-SE IPC messages are encapsulated in a UDP header 0 Automatically determine based on hypervisor type. 1 Use UDP encap unconditionally.Requires SE Reboot. Allowed values are 0-1. Field introduced in 17.1.2. SeUDPEncapIpc *int32 `json:"se_udp_encap_ipc,omitempty"` // Determines if DPDK library should be used or not 0 Automatically determine based on hypervisor type 1 Use DPDK if PCAP is not enabled 2 Don't use DPDK. Allowed values are 0-2. Field introduced in 18.1.3. SeUseDpdk *int32 `json:"se_use_dpdk,omitempty"` // Configure the frequency in milliseconds of software transmit spillover queue flush when enabled. This is necessary to flush any packets in the spillover queue in the absence of a packet transmit in the normal course of operation. Allowed values are 50-500. Special values are 0- 'disable'. Field introduced in 20.1.1. Unit is MILLISECONDS. SeVnicTxSwQueueFlushFrequency *int32 `json:"se_vnic_tx_sw_queue_flush_frequency,omitempty"` // Configure the size of software transmit spillover queue when enabled. Requires SE Reboot. Allowed values are 128-2048. Field introduced in 20.1.1. SeVnicTxSwQueueSize *int32 `json:"se_vnic_tx_sw_queue_size,omitempty"` // Maximum number of aggregated vs heartbeat packets to send in a batch. Allowed values are 1-256. Field introduced in 17.1.1. SeVsHbMaxPktsInBatch *int32 `json:"se_vs_hb_max_pkts_in_batch,omitempty"` // Maximum number of virtualservices for which heartbeat messages are aggregated in one packet. Allowed values are 1-1024. Field introduced in 17.1.1. SeVsHbMaxVsInPkt *int32 `json:"se_vs_hb_max_vs_in_pkt,omitempty"` // Enable SEs to elect a primary amongst themselves in the absence of a connectivity to controller. Field introduced in 18.1.2. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. SelfSeElection *bool `json:"self_se_election,omitempty"` // Timeout for sending SE_READY without NS HELPER registration completion. Allowed values are 10-600. Field introduced in 21.1.1. Unit is SECONDS. SendSeReadyTimeout *int32 `json:"send_se_ready_timeout,omitempty"` // IPv6 Subnets assigned to the SE group. Required for VS group placement. Field introduced in 18.1.1. Maximum of 128 items allowed. ServiceIp6Subnets []*IPAddrPrefix `json:"service_ip6_subnets,omitempty"` // Subnets assigned to the SE group. Required for VS group placement. Field introduced in 17.1.1. Maximum of 128 items allowed. ServiceIPSubnets []*IPAddrPrefix `json:"service_ip_subnets,omitempty"` // Minimum required shared memory to apply any configuration. Allowed values are 0-100. Field introduced in 18.1.2. Unit is MB. ShmMinimumConfigMemory *int32 `json:"shm_minimum_config_memory,omitempty"` // This setting limits the number of significant logs generated per second per core on this SE. Default is 100 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. SignificantLogThrottle *int32 `json:"significant_log_throttle,omitempty"` // (Beta) Preprocess SSL Client Hello for SNI hostname extension.If set to True, this will apply SNI child's SSL protocol(s), if they are different from SNI Parent's allowed SSL protocol(s). Field introduced in 17.2.12, 18.1.3. SslPreprocessSniHostname *bool `json:"ssl_preprocess_sni_hostname,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` TransientSharedMemoryMax *int32 `json:"transient_shared_memory_max,omitempty"` // This setting limits the number of UDF logs generated per second per core on this SE. UDF logs are generated due to the configured client log filters or the rules with logging enabled. Default is 100 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. UdfLogThrottle *int32 `json:"udf_log_throttle,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Enables the use of hyper-threaded cores on SE. Requires SE Reboot. Field introduced in 20.1.1. UseHyperthreadedCores *bool `json:"use_hyperthreaded_cores,omitempty"` // Enable InterSE Objsyc distribution framework. Field introduced in 20.1.3. Allowed in Basic edition, Essentials edition, Enterprise edition. UseObjsync *bool `json:"use_objsync,omitempty"` // Use Standard SKU Azure Load Balancer. By default cloud level flag is set. If not set, it inherits/uses the use_standard_alb flag from the cloud. Field introduced in 18.2.3. UseStandardAlb *bool `json:"use_standard_alb,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Placeholder for description of property vcenter_clusters of obj type ServiceEngineGroup field type str type object VcenterClusters *VcenterClusters `json:"vcenter_clusters,omitempty"` // Enum options - VCENTER_DATASTORE_ANY, VCENTER_DATASTORE_LOCAL, VCENTER_DATASTORE_SHARED. VcenterDatastoreMode *string `json:"vcenter_datastore_mode,omitempty"` // Placeholder for description of property vcenter_datastores of obj type ServiceEngineGroup field type str type object VcenterDatastores []*VcenterDatastore `json:"vcenter_datastores,omitempty"` // Placeholder for description of property vcenter_datastores_include of obj type ServiceEngineGroup field type str type boolean VcenterDatastoresInclude *bool `json:"vcenter_datastores_include,omitempty"` // Folder to place all the Service Engine virtual machines in vCenter. VcenterFolder *string `json:"vcenter_folder,omitempty"` // Placeholder for description of property vcenter_hosts of obj type ServiceEngineGroup field type str type object VcenterHosts *VcenterHosts `json:"vcenter_hosts,omitempty"` // VCenter information for scoping at Host/Cluster level. Field introduced in 20.1.1. Vcenters []*PlacementScopeConfig `json:"vcenters,omitempty"` // Number of vcpus for each of the Service Engine virtual machines. Changes to this setting do not affect existing SEs. VcpusPerSe *int32 `json:"vcpus_per_se,omitempty"` // When vip_asg is set, Vip configuration will be managed by Avi.User will be able to configure vip_asg or Vips individually at the time of create. Field introduced in 17.2.12, 18.1.2. VipAsg *VipAutoscaleGroup `json:"vip_asg,omitempty"` // DHCP ip check interval. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is SEC. VnicDhcpIPCheckInterval *int32 `json:"vnic_dhcp_ip_check_interval,omitempty"` // DHCP ip max retries. Field introduced in 21.1.1. VnicDhcpIPMaxRetries *int32 `json:"vnic_dhcp_ip_max_retries,omitempty"` // wait interval before deleting IP. . Field introduced in 21.1.1. Unit is SEC. VnicIPDeleteInterval *int32 `json:"vnic_ip_delete_interval,omitempty"` // Probe vnic interval. Field introduced in 21.1.1. Unit is SEC. VnicProbeInterval *int32 `json:"vnic_probe_interval,omitempty"` // Time interval for retrying the failed VNIC RPC requests. Field introduced in 21.1.1. Unit is SEC. VnicRPCRetryInterval *int32 `json:"vnic_rpc_retry_interval,omitempty"` // Size of vnicdb command history. Allowed values are 0-65535. Field introduced in 21.1.1. VnicdbCmdHistorySize *int32 `json:"vnicdb_cmd_history_size,omitempty"` // Ensure primary and secondary Service Engines are deployed on different physical hosts. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Special default for Basic edition is true, Essentials edition is true, Enterprise is True. VsHostRedundancy *bool `json:"vs_host_redundancy,omitempty"` // Time to wait for the scaled in SE to drain existing flows before marking the scalein done. Unit is SEC. VsScaleinTimeout *int32 `json:"vs_scalein_timeout,omitempty"` // During SE upgrade, Time to wait for the scaled-in SE to drain existing flows before marking the scalein done. Unit is SEC. VsScaleinTimeoutForUpgrade *int32 `json:"vs_scalein_timeout_for_upgrade,omitempty"` // Time to wait for the scaled out SE to become ready before marking the scaleout done. Unit is SEC. VsScaleoutTimeout *int32 `json:"vs_scaleout_timeout,omitempty"` // Wait time for sending scaleout ready notification after Virtual Service is marked UP. In certain deployments, there may be an additional delay to accept traffic. For example, for BGP, some time is needed for route advertisement. Allowed values are 0-20. Field introduced in 18.1.5,18.2.1. Unit is SEC. VsSeScaleoutAdditionalWaitTime *int32 `json:"vs_se_scaleout_additional_wait_time,omitempty"` // Timeout in seconds for Service Engine to sendScaleout Ready notification of a Virtual Service. Allowed values are 0-90. Field introduced in 18.1.5,18.2.1. Unit is SEC. VsSeScaleoutReadyTimeout *int32 `json:"vs_se_scaleout_ready_timeout,omitempty"` // During SE upgrade in a legacy active/standby segroup, Time to wait for the new primary SE to accept flows before marking the switchover done. Field introduced in 17.2.13,18.1.4,18.2.1. Unit is SEC. VsSwitchoverTimeout *int32 `json:"vs_switchover_timeout,omitempty"` // Parameters to place Virtual Services on only a subset of the cores of an SE. Field introduced in 17.2.5. VssPlacement *VssPlacement `json:"vss_placement,omitempty"` // If set, Virtual Services will be placed on only a subset of the cores of an SE. Field introduced in 18.1.1. VssPlacementEnabled *bool `json:"vss_placement_enabled,omitempty"` // Frequency with which SE publishes WAF learning. Allowed values are 1-43200. Field deprecated in 18.2.3. Field introduced in 18.1.2. Unit is MIN. WafLearningInterval *int32 `json:"waf_learning_interval,omitempty"` // Amount of memory reserved on SE for WAF learning. This can be atmost 5% of SE memory. Field deprecated in 18.2.3. Field introduced in 18.1.2. Unit is MB. WafLearningMemory *int32 `json:"waf_learning_memory,omitempty"` // Enable memory pool for WAF.Requires SE Reboot. Field introduced in 17.2.3. WafMempool *bool `json:"waf_mempool,omitempty"` // Memory pool size used for WAF.Requires SE Reboot. Field introduced in 17.2.3. Unit is KB. WafMempoolSize *int32 `json:"waf_mempool_size,omitempty"` }
ServiceEngineGroup service engine group swagger:model ServiceEngineGroup
type ServiceEngineGroupAPIResponse ¶
type ServiceEngineGroupAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*ServiceEngineGroup `json:"results,omitempty"` }
ServiceEngineGroupAPIResponse service engine group Api response swagger:model ServiceEngineGroupApiResponse
type ServiceEngineLimits ¶
type ServiceEngineLimits struct { // Maximum number of virtualservices per serviceengine, including east-west virtualservices. Field introduced in 20.1.1. AllVirtualservicesPerServiceengine *int32 `json:"all_virtualservices_per_serviceengine,omitempty"` // Maximum number of east-west virtualservices per serviceengine, excluding north-south virtualservices. Field introduced in 20.1.1. EwVirtualservicesPerServiceengine *int32 `json:"ew_virtualservices_per_serviceengine,omitempty"` // Maximum number of north-south virtualservices per serviceengine, excluding east-west virtualservices. Field introduced in 20.1.1. NsVirtualservicesPerServiceengine *int32 `json:"ns_virtualservices_per_serviceengine,omitempty"` // Maximum number of logical interfaces (vlan, bond) per serviceengine. Field introduced in 20.1.1. NumLogicalIntfPerSe *int32 `json:"num_logical_intf_per_se,omitempty"` // Maximum number of physical interfaces per serviceengine. Field introduced in 20.1.1. NumPhyIntfPerSe *int32 `json:"num_phy_intf_per_se,omitempty"` // Maximum number of virtualservices with realtime metrics enabled. Field introduced in 20.1.1. NumVirtualservicesRtMetrics *int32 `json:"num_virtualservices_rt_metrics,omitempty"` // Maximum number of vlan interfaces per physical interface. Field introduced in 20.1.1. NumVlanIntfPerPhyIntf *int32 `json:"num_vlan_intf_per_phy_intf,omitempty"` // Maximum number of vlan interfaces per serviceengine. Field introduced in 20.1.1. NumVlanIntfPerSe *int32 `json:"num_vlan_intf_per_se,omitempty"` // Serviceengine system limits specific to cloud type. Field introduced in 20.1.1. ServiceengineCloudLimits []*ServiceEngineCloudLimits `json:"serviceengine_cloud_limits,omitempty"` }
ServiceEngineLimits service engine limits swagger:model ServiceEngineLimits
type ServiceMatch ¶
type ServiceMatch struct { // Destination Port of the packet. Field introduced in 18.2.5. DestinationPort *PortMatch `json:"destination_port,omitempty"` // Protocol to match. Supported protocols are TCP, UDP and ICMP. Field introduced in 20.1.1. Protocol *L4RuleProtocolMatch `json:"protocol,omitempty"` // Source Port of the packet. Field introduced in 18.2.5. SourcePort *PortMatch `json:"source_port,omitempty"` }
ServiceMatch service match swagger:model ServiceMatch
type ServicePoolSelector ¶
type ServicePoolSelector struct { // It is a reference to an object of type PoolGroup. ServicePoolGroupRef *string `json:"service_pool_group_ref,omitempty"` // It is a reference to an object of type Pool. ServicePoolRef *string `json:"service_pool_ref,omitempty"` // Pool based destination port. Allowed values are 1-65535. // Required: true ServicePort *int32 `json:"service_port"` // The end of the Service port number range. Allowed values are 1-65535. Special values are 0- 'single port'. Field introduced in 17.2.4. ServicePortRangeEnd *int32 `json:"service_port_range_end,omitempty"` // Destination protocol to match for the pool selection. If not specified, it will match any protocol. Enum options - PROTOCOL_TYPE_TCP_PROXY, PROTOCOL_TYPE_TCP_FAST_PATH, PROTOCOL_TYPE_UDP_FAST_PATH, PROTOCOL_TYPE_UDP_PROXY. ServiceProtocol *string `json:"service_protocol,omitempty"` }
ServicePoolSelector service pool selector swagger:model ServicePoolSelector
type SidebandProfile ¶
type SidebandProfile struct { // IP Address of the sideband server. IP []*IPAddr `json:"ip,omitempty"` // Maximum size of the request body that will be sent on the sideband. Allowed values are 0-16384. Unit is BYTES. SidebandMaxRequestBodySize *int32 `json:"sideband_max_request_body_size,omitempty"` }
SidebandProfile sideband profile swagger:model SidebandProfile
type SipLog ¶
type SipLog struct { // Server connection protocol type. Enum options - PROTOCOL_ICMP, PROTOCOL_TCP, PROTOCOL_UDP. Field introduced in 17.2.12, 18.1.3, 18.2.1. ServerProtocol *string `json:"server_protocol,omitempty"` // SIP CallId header. Field introduced in 17.2.12, 18.1.3, 18.2.1. SipCallidHdr *string `json:"sip_callid_hdr,omitempty"` // Client's SIP Contact header. Field introduced in 17.2.12, 18.1.3, 18.2.1. SipContactHdr *string `json:"sip_contact_hdr,omitempty"` // SIP From header. Field introduced in 17.2.12, 18.1.3, 18.2.1. SipFromHdr *string `json:"sip_from_hdr,omitempty"` // SIP Messages. Field introduced in 17.2.12, 18.1.3, 18.2.1. SipMessages []*SipMessage `json:"sip_messages,omitempty"` // SIP To header. Field introduced in 17.2.12, 18.1.3, 18.2.1. SipToHdr *string `json:"sip_to_hdr,omitempty"` }
SipLog sip log swagger:model SipLog
type SipMessage ¶
type SipMessage struct { // Contents up to first 128 bytes of a SIP message for which could not be parsed. Field introduced in 17.2.12, 18.1.3, 18.2.1. Content *string `json:"content,omitempty"` // Indicates if SIP message is received from a client. Field introduced in 17.2.12, 18.1.3, 18.2.1. FromClient *bool `json:"from_client,omitempty"` // SIP request method string. Field introduced in 17.2.12, 18.1.3, 18.2.1. Method *string `json:"method,omitempty"` // SIP message receive time stamp. Field introduced in 17.2.12, 18.1.3, 18.2.1. RcvTimestamp *int64 `json:"rcv_timestamp,omitempty"` // SIP message size before modifications. Field introduced in 17.2.12, 18.1.3, 18.2.1. RxBytes *int32 `json:"rx_bytes,omitempty"` // SIP response status string. Field introduced in 17.2.12, 18.1.3, 18.2.1. Status *string `json:"status,omitempty"` // SIP response status code, 2xx response means success. Field introduced in 17.2.12, 18.1.3, 18.2.1. StatusCode *int32 `json:"status_code,omitempty"` // SIP message size post modifications. Field introduced in 17.2.12, 18.1.3, 18.2.1. TxBytes *int32 `json:"tx_bytes,omitempty"` }
SipMessage sip message swagger:model SipMessage
type SipServiceApplicationProfile ¶
type SipServiceApplicationProfile struct { // SIP transaction timeout in seconds. Allowed values are 2-512. Field introduced in 17.2.8, 18.1.3, 18.2.1. Unit is SEC. TransactionTimeout *int32 `json:"transaction_timeout,omitempty"` }
SipServiceApplicationProfile sip service application profile swagger:model SipServiceApplicationProfile
type SiteVersion ¶
type SiteVersion struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // This field represents the creation time of the federateddiff. Field introduced in 20.1.1. Datetime *string `json:"datetime,omitempty"` // Name of the Site. Field introduced in 20.1.1. // Required: true Name *string `json:"name"` // Previous targer version for a site. Field introduced in 20.1.1. PrevTargetVersion *int64 `json:"prev_target_version,omitempty"` // Replication state for a site. Enum options - REPLICATION_STATE_FASTFORWARD, REPLICATION_STATE_FORCESYNC, REPLICATION_STATE_STREAMING, REPLICATION_STATE_SUSPENDED, REPLICATION_STATE_INIT, REPLICATION_STATE_WAIT, REPLICATION_STATE_NOT_APPLICABLE. Field introduced in 20.1.1. ReplicationState *string `json:"replication_state,omitempty"` // Cluster UUID of the site. Field introduced in 20.1.1. SiteID *string `json:"site_id,omitempty"` // Target timeline of the site. Field introduced in 20.1.1. TargetTimeline *string `json:"target_timeline,omitempty"` // Target version of the site. Field introduced in 20.1.1. TargetVersion *int64 `json:"target_version,omitempty"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 20.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // Timeline of the site. Field introduced in 20.1.1. Timeline *string `json:"timeline,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the SiteVersion object. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` // Version of the site. Field introduced in 20.1.1. Version *int64 `json:"version,omitempty"` // Type of message for which version is maintained. Enum options - CONFIG_VERSION, HEALTH_STATUS_VERSION. Field introduced in 20.1.1. VersionType *string `json:"version_type,omitempty"` }
SiteVersion site version swagger:model SiteVersion
type SiteVersionAPIResponse ¶
type SiteVersionAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SiteVersion `json:"results,omitempty"` }
SiteVersionAPIResponse site version Api response swagger:model SiteVersionApiResponse
type SnmpConfiguration ¶
type SnmpConfiguration struct { // Community *string for SNMP v2c. Community *string `json:"community,omitempty"` // Support for 4096 bytes trap payload. Field introduced in 17.2.13,18.1.4,18.2.1. LargeTrapPayload *bool `json:"large_trap_payload,omitempty"` // SNMP version 3 configuration. Field introduced in 17.2.3. SnmpV3Config *SnmpV3Configuration `json:"snmp_v3_config,omitempty"` // Sets the sysContact in system MIB. SysContact *string `json:"sys_contact,omitempty"` // Sets the sysLocation in system MIB. SysLocation *string `json:"sys_location,omitempty"` // SNMP version support. V2 or V3. Enum options - SNMP_VER2, SNMP_VER3. Field introduced in 17.2.3. Version *string `json:"version,omitempty"` }
SnmpConfiguration snmp configuration swagger:model SnmpConfiguration
type SnmpTrapProfile ¶
type SnmpTrapProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // A user-friendly name of the SNMP trap configuration. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // The IP address or hostname of the SNMP trap destination server. TrapServers []*SnmpTrapServer `json:"trap_servers,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the SNMP trap profile object. UUID *string `json:"uuid,omitempty"` }
SnmpTrapProfile snmp trap profile swagger:model SnmpTrapProfile
type SnmpTrapProfileAPIResponse ¶
type SnmpTrapProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SnmpTrapProfile `json:"results,omitempty"` }
SnmpTrapProfileAPIResponse snmp trap profile Api response swagger:model SnmpTrapProfileApiResponse
type SnmpTrapServer ¶
type SnmpTrapServer struct { // The community *string to communicate with the trap server. Community *string `json:"community,omitempty"` // IP Address of the SNMP trap destination. // Required: true IPAddr *IPAddr `json:"ip_addr"` // The UDP port of the trap server. Field introduced in 16.5.4,17.2.5. Port *int32 `json:"port,omitempty"` // SNMP version 3 configuration. Field introduced in 17.2.3. User *SnmpV3UserParams `json:"user,omitempty"` // SNMP version support. V2 or V3. Enum options - SNMP_VER2, SNMP_VER3. Field introduced in 17.2.3. Version *string `json:"version,omitempty"` }
SnmpTrapServer snmp trap server swagger:model SnmpTrapServer
type SnmpV3Configuration ¶
type SnmpV3Configuration struct { // Engine Id of the Avi Controller SNMP. Field introduced in 17.2.3. EngineID *string `json:"engine_id,omitempty"` // SNMP ver 3 user definition. Field introduced in 17.2.3. User *SnmpV3UserParams `json:"user,omitempty"` }
SnmpV3Configuration snmp v3 configuration swagger:model SnmpV3Configuration
type SnmpV3UserParams ¶
type SnmpV3UserParams struct { // SNMP V3 authentication passphrase. Field introduced in 17.2.3. AuthPassphrase *string `json:"auth_passphrase,omitempty"` // SNMP V3 user authentication type. Enum options - SNMP_V3_AUTH_MD5, SNMP_V3_AUTH_SHA, SNMP_V3_AUTH_SHA_224, SNMP_V3_AUTH_SHA_256, SNMP_V3_AUTH_SHA_384, SNMP_V3_AUTH_SHA_512. Field introduced in 17.2.3. AuthType *string `json:"auth_type,omitempty"` // SNMP V3 privacy passphrase. Field introduced in 17.2.3. PrivPassphrase *string `json:"priv_passphrase,omitempty"` // SNMP V3 privacy setting. Enum options - SNMP_V3_PRIV_DES, SNMP_V3_PRIV_AES. Field introduced in 17.2.3. PrivType *string `json:"priv_type,omitempty"` // SNMP username to be used by SNMP clients for performing SNMP walk. Field introduced in 17.2.3. Username *string `json:"username,omitempty"` }
SnmpV3UserParams snmp v3 user params swagger:model SnmpV3UserParams
type StateCacheMgrDebugFilter ¶
type StateCacheMgrDebugFilter struct { // Pool UUID. It is a reference to an object of type Pool. PoolRef *string `json:"pool_ref,omitempty"` // VirtualService UUID. It is a reference to an object of type VirtualService. VsRef *string `json:"vs_ref,omitempty"` }
StateCacheMgrDebugFilter state cache mgr debug filter swagger:model StateCacheMgrDebugFilter
type StaticIPAllocInfo ¶
type StaticIPAllocInfo struct { // IP address. Field introduced in 20.1.3. // Required: true IP *IPAddr `json:"ip"` // Object metadata. Field introduced in 20.1.3. ObjInfo *string `json:"obj_info,omitempty"` // Object which this IP address is allocated to. Field introduced in 20.1.3. ObjUUID *string `json:"obj_uuid,omitempty"` }
StaticIPAllocInfo static Ip alloc info swagger:model StaticIpAllocInfo
type StaticIPRange ¶
type StaticIPRange struct { // IP range. Field introduced in 20.1.3. // Required: true Range *IPAddrRange `json:"range"` // Object type (VIP only, Service Engine only, or both) which can use this IP range. Enum options - STATIC_IPS_FOR_SE, STATIC_IPS_FOR_VIP, STATIC_IPS_FOR_VIP_AND_SE. Field introduced in 20.1.3. Type *string `json:"type,omitempty"` }
StaticIPRange static Ip range swagger:model StaticIpRange
type StaticIPRangeRuntime ¶
type StaticIPRangeRuntime struct { // Allocated IPs. Field introduced in 20.1.3. AllocatedIps []*StaticIPAllocInfo `json:"allocated_ips,omitempty"` // Free IP count. Field introduced in 20.1.3. FreeIPCount *int32 `json:"free_ip_count,omitempty"` // Total IP count. Field introduced in 20.1.3. TotalIPCount *int32 `json:"total_ip_count,omitempty"` // Object type (VIP only, Service Engine only, or both) which is using this IP group. Enum options - STATIC_IPS_FOR_SE, STATIC_IPS_FOR_VIP, STATIC_IPS_FOR_VIP_AND_SE. Field introduced in 20.1.3. Type *string `json:"type,omitempty"` }
StaticIPRangeRuntime static Ip range runtime swagger:model StaticIpRangeRuntime
type StaticRoute ¶
type StaticRoute struct { // Disable the gateway monitor for default gateway. They are monitored by default. Field introduced in 17.1.1. DisableGatewayMonitor *bool `json:"disable_gateway_monitor,omitempty"` // if_name of StaticRoute. IfName *string `json:"if_name,omitempty"` // Labels associated with this route. Field introduced in 20.1.1. Maximum of 1 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Placeholder for description of property next_hop of obj type StaticRoute field type str type object // Required: true NextHop *IPAddr `json:"next_hop"` // Placeholder for description of property prefix of obj type StaticRoute field type str type object // Required: true Prefix *IPAddrPrefix `json:"prefix"` // route_id of StaticRoute. // Required: true RouteID *string `json:"route_id"` }
StaticRoute static route swagger:model StaticRoute
type StreamingSyslogConfig ¶
type StreamingSyslogConfig struct { // Facility value, as defined in RFC5424, must be between 0 and 23 inclusive. Allowed values are 0-23. Field introduced in 18.1.1. Facility *int32 `json:"facility,omitempty"` // Severity code, as defined in RFC5424, for filtered logs. This must be between 0 and 7 inclusive. Allowed values are 0-7. Field introduced in 18.1.1. FilteredLogSeverity *int32 `json:"filtered_log_severity,omitempty"` // String to use as the hostname in the syslog messages. This *string can contain only printable ASCII characters (hex 21 to hex 7E; no space allowed). Field introduced in 18.1.1. Hostname *string `json:"hostname,omitempty"` // Severity code, as defined in RFC5424, for non-significant logs. This must be between 0 and 7 inclusive. Allowed values are 0-7. Field introduced in 18.1.1. NonSignificantLogSeverity *int32 `json:"non_significant_log_severity,omitempty"` // Severity code, as defined in RFC5424, for significant logs. This must be between 0 and 7 inclusive. Allowed values are 0-7. Field introduced in 18.1.1. SignificantLogSeverity *int32 `json:"significant_log_severity,omitempty"` }
StreamingSyslogConfig streaming syslog config swagger:model StreamingSyslogConfig
type StringGroup ¶
type StringGroup struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Configure Key Value in the *string group. Kv []*KeyValue `json:"kv,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Enable the longest match, default is the shortest match. Field introduced in 18.2.8. LongestMatch *bool `json:"longest_match,omitempty"` // Name of the *string group. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Type of StringGroup. Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the *string group. UUID *string `json:"uuid,omitempty"` }
StringGroup *string group swagger:model StringGroup
type StringGroupAPIResponse ¶
type StringGroupAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*StringGroup `json:"results,omitempty"` }
StringGroupAPIResponse *string group Api response swagger:model StringGroupApiResponse
type StringMatch ¶
type StringMatch struct { // Criterion to use for *string matching the HTTP request. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Basic(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Essentials(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Enterprise edition. // Required: true MatchCriteria *string `json:"match_criteria"` // String value(s). MatchStr []string `json:"match_str,omitempty"` // UUID of the *string group(s). It is a reference to an object of type StringGroup. StringGroupRefs []string `json:"string_group_refs,omitempty"` }
StringMatch *string match swagger:model StringMatch
type SubJob ¶
type SubJob struct { // Field introduced in 18.1.1. // Required: true ExpiresAt *string `json:"expires_at"` // Field introduced in 18.1.1. Metadata *string `json:"metadata,omitempty"` // Number of times the sub job got scheduled. Field introduced in 20.1.1. NumRetries *int32 `json:"num_retries,omitempty"` // Enum options - JOB_TYPE_VS_FULL_LOGS, JOB_TYPE_VS_UDF, JOB_TYPE_VS_METRICS_RT, JOB_TYPE_SSL_CERT, JOB_TYPE_DEBUGVS_PKT_CAPTURE, JOB_TYPE_CONSISTENCY_CHECK, JOB_TYPE_TECHSUPPORT, JOB_TYPE_PKI_PROFILE, JOB_TYPE_NSP_RULE, JOB_TYPE_SEGROUP_METRICS_RT, JOB_TYPE_POSTGRES_STATUS, JOB_TYPE_VS_ROTATE_KEYS, JOB_TYPE_POOL_DNS, JOB_TYPE_GSLB_SERVICE, JOB_TYPE_APP_PERSISTENCE, JOB_TYPE_PROCESS_LOCKED_USER_ACCOUNTS, JOB_TYPE_SESSION, JOB_TYPE_AUTHTOKEN, JOB_TYPE_CLUSTER, JOB_TYPE_SE_SECURE_CHANNEL_CLEANUP, JOB_TYPE_OCSP_STAPLE_STATUS, JOB_TYPE_FILE_OBJECT_CLEANUP, JOB_TYPE_WAF_POLICY_REFRESH_APPLICATION_SIGNATURES, JOB_TYPE_POOL_ASYNC, JOB_TYPE_PROCESS_BASELINE_BENCHMARK, JOB_TYPE_GEODB_REFRESH_CONTROLLER_DATABASES. Field introduced in 18.1.1. // Required: true Type *string `json:"type"` }
SubJob sub job swagger:model SubJob
type Subnet ¶
type Subnet struct { // Specify an IP subnet prefix for this Network. // Required: true Prefix *IPAddrPrefix `json:"prefix"` // Static IP ranges for this subnet. Field introduced in 20.1.3. StaticIPRanges []*StaticIPRange `json:"static_ip_ranges,omitempty"` // Use static_ip_ranges. Field deprecated in 20.1.3. StaticIps []*IPAddr `json:"static_ips,omitempty"` // Use static_ip_ranges. Field deprecated in 20.1.3. StaticRanges []*IPAddrRange `json:"static_ranges,omitempty"` }
Subnet subnet swagger:model Subnet
type SubnetRuntime ¶
type SubnetRuntime struct { // Moved to StaticIpRangeRuntime. Field deprecated in 20.1.3. FreeIPCount *int32 `json:"free_ip_count,omitempty"` // Use allocated_ips in StaticIpRangeRuntime. Field deprecated in 20.1.3. IPAlloced []*IPAllocInfo `json:"ip_alloced,omitempty"` // Static IP range runtime. Field introduced in 20.1.3. IPRangeRuntimes []*StaticIPRangeRuntime `json:"ip_range_runtimes,omitempty"` // Placeholder for description of property prefix of obj type SubnetRuntime field type str type object // Required: true Prefix *IPAddrPrefix `json:"prefix"` // Moved to StaticIpRangeRuntime. Field deprecated in 20.1.3. TotalIPCount *int32 `json:"total_ip_count,omitempty"` // Can be derived from total - free in StaticIpRangeRuntime. Field deprecated in 20.1.3. UsedIPCount *int32 `json:"used_ip_count,omitempty"` }
SubnetRuntime subnet runtime swagger:model SubnetRuntime
type SummarizedInfo ¶
type SummarizedInfo struct { // Placeholder for description of property subnet_info of obj type SummarizedInfo field type str type object SubnetInfo []*SummarizedSubnetInfo `json:"subnet_info,omitempty"` }
SummarizedInfo summarized info swagger:model SummarizedInfo
type SummarizedSubnetInfo ¶
type SummarizedSubnetInfo struct { // cidr_prefix of SummarizedSubnetInfo. // Required: true CidrPrefix *string `json:"cidr_prefix"` // network of SummarizedSubnetInfo. // Required: true Network *string `json:"network"` }
SummarizedSubnetInfo summarized subnet info swagger:model SummarizedSubnetInfo
type SupportedMigrations ¶
type SupportedMigrations struct { // Minimum accepted API version. Field introduced in 18.2.6. APIVersion *string `json:"api_version,omitempty"` // Minimum space required(in GB) on controller host for this image installation. Field introduced in 18.2.6. Unit is GB. ControllerHostMinFreeDiskSize *int32 `json:"controller_host_min_free_disk_size,omitempty"` // Minimum number of cores required for Controller. Field introduced in 18.2.10, 20.1.2. Allowed in Basic edition, Essentials edition, Enterprise edition. ControllerMinCores *int32 `json:"controller_min_cores,omitempty"` // Minimum supported Docker version required for Controller. Field introduced in 21.1.1. ControllerMinDockerVersion *string `json:"controller_min_docker_version,omitempty"` // Minimum space required(in GB) on controller for this image installation. Field introduced in 18.2.6. Unit is GB. ControllerMinFreeDiskSize *int32 `json:"controller_min_free_disk_size,omitempty"` // Minimum memory required(in GB) for Controller. Field introduced in 18.2.10, 20.1.2. Unit is GB. Allowed in Basic edition, Essentials edition, Enterprise edition. ControllerMinMemory *int32 `json:"controller_min_memory,omitempty"` // Minimum space required(in GB) for Controller. Field introduced in 18.2.10, 20.1.2. Unit is GB. Allowed in Basic edition, Essentials edition, Enterprise edition. ControllerMinTotalDisk *int32 `json:"controller_min_total_disk,omitempty"` // Supported active versions for this image. Field introduced in 18.2.6. MaxActiveVersions *int32 `json:"max_active_versions,omitempty"` // Minimum supported API version. Field introduced in 21.1.1. MinSupportedAPIVersion *string `json:"min_supported_api_version,omitempty"` // Minimum space required(in GB) on controller for rollback. Field introduced in 18.2.6. Unit is GB. RollbackControllerDiskSpace *int32 `json:"rollback_controller_disk_space,omitempty"` // Minimum space required(in GB) on se for rollback. Field introduced in 18.2.6. Unit is GB. RollbackSeDiskSpace *int32 `json:"rollback_se_disk_space,omitempty"` // Minimum space required(in GB) on se host for this image installation. Field introduced in 18.2.6. Unit is GB. SeHostMinFreeDiskSize *int32 `json:"se_host_min_free_disk_size,omitempty"` // Minimum number of cores required for se. Field introduced in 18.2.10, 20.1.2. Allowed in Basic edition, Essentials edition, Enterprise edition. SeMinCores *int32 `json:"se_min_cores,omitempty"` // Minimum space required(in GB) on se for this image installation. Field introduced in 18.2.6. Unit is GB. SeMinFreeDiskSize *int32 `json:"se_min_free_disk_size,omitempty"` // Minimum memory required(in GB) for se. Field introduced in 18.2.10, 20.1.2. Unit is GB. Allowed in Basic edition, Essentials edition, Enterprise edition. SeMinMemory *int32 `json:"se_min_memory,omitempty"` // Minimum space required(in GB) for se. Field introduced in 18.2.10, 20.1.2. Unit is GB. Allowed in Basic edition, Essentials edition, Enterprise edition. SeMinTotalDisk *int32 `json:"se_min_total_disk,omitempty"` // Supported compatible versions for this image. Field introduced in 18.2.6. Versions []string `json:"versions,omitempty"` }
SupportedMigrations supported migrations swagger:model SupportedMigrations
type SwitchoverEventDetails ¶
type SwitchoverEventDetails struct { // from_se_name of SwitchoverEventDetails. FromSeName *string `json:"from_se_name,omitempty"` // ip of SwitchoverEventDetails. IP *string `json:"ip,omitempty"` // ip6 of SwitchoverEventDetails. Ip6 *string `json:"ip6,omitempty"` // to_se_name of SwitchoverEventDetails. ToSeName *string `json:"to_se_name,omitempty"` // vs_name of SwitchoverEventDetails. VsName *string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID *string `json:"vs_uuid,omitempty"` }
SwitchoverEventDetails switchover event details swagger:model SwitchoverEventDetails
type SwitchoverFailEventDetails ¶
type SwitchoverFailEventDetails struct { // from_se_name of SwitchoverFailEventDetails. FromSeName *string `json:"from_se_name,omitempty"` // ip of SwitchoverFailEventDetails. IP *string `json:"ip,omitempty"` // ip6 of SwitchoverFailEventDetails. Ip6 *string `json:"ip6,omitempty"` // reason of SwitchoverFailEventDetails. Reason *string `json:"reason,omitempty"` // vs_name of SwitchoverFailEventDetails. VsName *string `json:"vs_name,omitempty"` // Unique object identifier of vs. VsUUID *string `json:"vs_uuid,omitempty"` }
SwitchoverFailEventDetails switchover fail event details swagger:model SwitchoverFailEventDetails
type SysTestEmailParams ¶
type SysTestEmailParams struct { // Alerts are copied to the comma separated list of email recipients. CcEmails *string `json:"cc_emails,omitempty"` // The Subject line of the originating email from Avi Controller. // Required: true Subject *string `json:"subject"` // The email context. // Required: true Text *string `json:"text"` // Alerts are sent to the comma separated list of email recipients. // Required: true ToEmails *string `json:"to_emails"` }
SysTestEmailParams sys test email params swagger:model SysTestEmailParams
type SystemConfiguration ¶
type SystemConfiguration struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Placeholder for description of property admin_auth_configuration of obj type SystemConfiguration field type str type object AdminAuthConfiguration *AdminAuthConfiguration `json:"admin_auth_configuration,omitempty"` // Enable Common Criteria Compliance mode (Disabled by default). WARN Toggling this field is disruptive and will result in reduced behavior with SSH and TLS protocols. Expect possible warm start of control and data planes. Field introduced in 20.1.3. CommonCriteriaMode *bool `json:"common_criteria_mode,omitempty"` // Specifies the default license tier which would be used by new Clouds. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS. Field introduced in 17.2.5. Allowed in Basic edition, Essentials edition, Enterprise edition. Special default for Basic edition is BASIC, Essentials edition is ESSENTIALS, Enterprise is ENTERPRISE. DefaultLicenseTier *string `json:"default_license_tier,omitempty"` // Placeholder for description of property dns_configuration of obj type SystemConfiguration field type str type object DNSConfiguration *DNSConfiguration `json:"dns_configuration,omitempty"` // DNS virtualservices hosting FQDN records for applications across Avi Vantage. If no virtualservices are provided, Avi Vantage will provide DNS services for configured applications. Switching back to Avi Vantage from DNS virtualservices is not allowed. It is a reference to an object of type VirtualService. DNSVirtualserviceRefs []string `json:"dns_virtualservice_refs,omitempty"` // Placeholder for description of property docker_mode of obj type SystemConfiguration field type str type boolean DockerMode *bool `json:"docker_mode,omitempty"` // Placeholder for description of property email_configuration of obj type SystemConfiguration field type str type object EmailConfiguration *EmailConfiguration `json:"email_configuration,omitempty"` // Enable CORS Header. Field introduced in 20.1.3. Allowed in Basic edition, Essentials edition, Enterprise edition. EnableCors *bool `json:"enable_cors,omitempty"` // Enable FIPS mode. Field introduced in 20.1.1. FipsMode *bool `json:"fips_mode,omitempty"` // Placeholder for description of property global_tenant_config of obj type SystemConfiguration field type str type object GlobalTenantConfig *TenantConfiguration `json:"global_tenant_config,omitempty"` // Placeholder for description of property linux_configuration of obj type SystemConfiguration field type str type object LinuxConfiguration *LinuxConfiguration `json:"linux_configuration,omitempty"` // Configure Ip Access control for controller to restrict open access. MgmtIPAccessControl *MgmtIPAccessControl `json:"mgmt_ip_access_control,omitempty"` // Placeholder for description of property ntp_configuration of obj type SystemConfiguration field type str type object NtpConfiguration *NTPConfiguration `json:"ntp_configuration,omitempty"` // Placeholder for description of property portal_configuration of obj type SystemConfiguration field type str type object PortalConfiguration *PortalConfiguration `json:"portal_configuration,omitempty"` // Placeholder for description of property proxy_configuration of obj type SystemConfiguration field type str type object ProxyConfiguration *ProxyConfiguration `json:"proxy_configuration,omitempty"` // Configure Secure Channel properties. Field introduced in 18.1.4, 18.2.1. SecureChannelConfiguration *SecureChannelConfiguration `json:"secure_channel_configuration,omitempty"` // Placeholder for description of property snmp_configuration of obj type SystemConfiguration field type str type object SnmpConfiguration *SnmpConfiguration `json:"snmp_configuration,omitempty"` // Allowed Ciphers list for SSH to the management interface on the Controller and Service Engines. If this is not specified, all the default ciphers are allowed. SSHCiphers []string `json:"ssh_ciphers,omitempty"` // Allowed HMAC list for SSH to the management interface on the Controller and Service Engines. If this is not specified, all the default HMACs are allowed. SSHHmacs []string `json:"ssh_hmacs,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // This flag is set once the Initial Controller Setup workflow is complete. Field introduced in 18.2.3. WelcomeWorkflowComplete *bool `json:"welcome_workflow_complete,omitempty"` }
SystemConfiguration system configuration swagger:model SystemConfiguration
type SystemConfigurationAPIResponse ¶
type SystemConfigurationAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SystemConfiguration `json:"results,omitempty"` }
SystemConfigurationAPIResponse system configuration Api response swagger:model SystemConfigurationApiResponse
type SystemLimits ¶
type SystemLimits struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // System limits for the entire controller cluster. Field introduced in 20.1.1. ControllerLimits *ControllerLimits `json:"controller_limits,omitempty"` // Possible controller sizes. Field introduced in 20.1.1. ControllerSizes []*ControllerSize `json:"controller_sizes,omitempty"` // System limits that apply to a serviceengine. Field introduced in 20.1.1. ServiceengineLimits *ServiceEngineLimits `json:"serviceengine_limits,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID for the system limits object. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` }
SystemLimits system limits swagger:model SystemLimits
type SystemLimitsAPIResponse ¶
type SystemLimitsAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*SystemLimits `json:"results,omitempty"` }
SystemLimitsAPIResponse system limits Api response swagger:model SystemLimitsApiResponse
type SystemUpgradeDetails ¶
type SystemUpgradeDetails struct { // Upgrade status. UpgradeStatus *SystemUpgradeState `json:"upgrade_status,omitempty"` }
SystemUpgradeDetails system upgrade details swagger:model SystemUpgradeDetails
type SystemUpgradeState ¶
type SystemUpgradeState struct { // upgrade state from controller. ControllerState *ControllerUpgradeState `json:"controller_state,omitempty"` // upgrade duration. Field introduced in 17.1.1. Unit is SEC. Duration *int32 `json:"duration,omitempty"` // upgrade end time. Field introduced in 17.1.1. EndTime *string `json:"end_time,omitempty"` // current version. Field introduced in 17.1.1. FromVersion *string `json:"from_version,omitempty"` // set if upgrade is in progress. // Required: true InProgress *bool `json:"in_progress"` // is set true, if patch upgrade requested by the user. Field introduced in 17.2.8. IsPatch *bool `json:"is_patch,omitempty"` // type of patch upgrade. Field introduced in 17.2.8. PatchType *string `json:"patch_type,omitempty"` // reason for upgrade failure. Field introduced in 17.1.1. Reason *string `json:"reason,omitempty"` // upgrade result. Field introduced in 17.1.1. Result *string `json:"result,omitempty"` // set if rollback is requested by the user. Rollback *bool `json:"rollback,omitempty"` // upgrade state of service engines. SeState *SeUpgradeStatusSummary `json:"se_state,omitempty"` // upgrade start time. Field introduced in 17.1.1. StartTime *string `json:"start_time,omitempty"` // version to upgrade to. Field introduced in 17.1.1. ToVersion *string `json:"to_version,omitempty"` }
SystemUpgradeState system upgrade state swagger:model SystemUpgradeState
type TCPApplicationProfile ¶
type TCPApplicationProfile struct { // Select the PKI profile to be associated with the Virtual Service. This profile defines the Certificate Authority and Revocation List. It is a reference to an object of type PKIProfile. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. PkiProfileRef *string `json:"pki_profile_ref,omitempty"` // Enable/Disable the usage of proxy protocol to convey client connection information to the back-end servers. Valid only for L4 application profiles and TCP proxy. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. ProxyProtocolEnabled *bool `json:"proxy_protocol_enabled,omitempty"` // Version of proxy protocol to be used to convey client connection information to the back-end servers. Enum options - PROXY_PROTOCOL_VERSION_1, PROXY_PROTOCOL_VERSION_2. Allowed in Basic(Allowed values- PROXY_PROTOCOL_VERSION_1) edition, Essentials(Allowed values- PROXY_PROTOCOL_VERSION_1) edition, Enterprise edition. ProxyProtocolVersion *string `json:"proxy_protocol_version,omitempty"` // Specifies whether the client side verification is set to none, request or require. Enum options - SSL_CLIENT_CERTIFICATE_NONE, SSL_CLIENT_CERTIFICATE_REQUEST, SSL_CLIENT_CERTIFICATE_REQUIRE. Field introduced in 18.2.3. Allowed in Basic(Allowed values- SSL_CLIENT_CERTIFICATE_NONE) edition, Essentials(Allowed values- SSL_CLIENT_CERTIFICATE_NONE) edition, Enterprise edition. SslClientCertificateMode *string `json:"ssl_client_certificate_mode,omitempty"` }
TCPApplicationProfile TCP application profile swagger:model TCPApplicationProfile
type TCPFastPathProfile ¶
type TCPFastPathProfile struct { // DSR profile information. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. DsrProfile *DsrProfile `json:"dsr_profile,omitempty"` // When enabled, Avi will complete the 3-way handshake with the client before forwarding any packets to the server. This will protect the server from SYN flood and half open SYN connections. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EnableSynProtection *bool `json:"enable_syn_protection,omitempty"` // The amount of time (in sec) for which a connection needs to be idle before it is eligible to be deleted. Allowed values are 5-14400. Special values are 0 - 'infinite'. Unit is SEC. SessionIDLETimeout *int32 `json:"session_idle_timeout,omitempty"` }
TCPFastPathProfile TCP fast path profile swagger:model TCPFastPathProfile
type TCPProxyProfile ¶
type TCPProxyProfile struct { // Controls the our congestion window to send, normally it's 1 mss, If this option is turned on, we use 10 msses. AggressiveCongestionAvoidance *bool `json:"aggressive_congestion_avoidance,omitempty"` // Controls whether the windows are static or supports autogrowth. Maximum that it can grow to is limited to 4MB. Field introduced in 20.1.1. AutoWindowGrowth *bool `json:"auto_window_growth,omitempty"` // Dynamically pick the relevant parameters for connections. Allowed in Basic(Allowed values- true) edition, Enterprise edition. Automatic *bool `json:"automatic,omitempty"` // Controls the congestion control algorithm we use. Enum options - CC_ALGO_NEW_RENO, CC_ALGO_CUBIC, CC_ALGO_HTCP. CcAlgo *string `json:"cc_algo,omitempty"` // Congestion window scaling factor after recovery. Allowed values are 0-8. Field introduced in 17.2.12, 18.1.3, 18.2.1. CongestionRecoveryScalingFactor *int32 `json:"congestion_recovery_scaling_factor,omitempty"` // The duration for keepalive probes or session idle timeout. Max value is 3600 seconds, min is 5. Set to 0 to allow infinite idle time. Allowed values are 5-14400. Special values are 0 - 'infinite'. Unit is SEC. IDLEConnectionTimeout *int32 `json:"idle_connection_timeout,omitempty"` // Controls the behavior of idle connections. Enum options - KEEP_ALIVE, CLOSE_IDLE. IDLEConnectionType *string `json:"idle_connection_type,omitempty"` // A new SYN is accepted from the same 4-tuple even if there is already a connection in TIME_WAIT state. This is equivalent of setting Time Wait Delay to 0. IgnoreTimeWait *bool `json:"ignore_time_wait,omitempty"` // Controls the value of the Differentiated Services Code Point field inserted in the IP header. This has two options Set to a specific value, or Pass Through, which uses the incoming DSCP value. Allowed values are 0-63. Special values are MAX - 'Passthrough'. IPDscp *int32 `json:"ip_dscp,omitempty"` // Controls whether to keep the connection alive with keepalive messages in the TCP half close state. The interval for sending keepalive messages is 30s. If a timeout is already configured in the network profile, this will not override it. Field introduced in 18.2.6. KeepaliveInHalfcloseState *bool `json:"keepalive_in_halfclose_state,omitempty"` // The number of attempts at retransmit before closing the connection. Allowed values are 3-8. MaxRetransmissions *int32 `json:"max_retransmissions,omitempty"` // Maximum TCP segment size. Allowed values are 512-9000. Special values are 0 - 'Use Interface MTU'. Unit is BYTES. MaxSegmentSize *int32 `json:"max_segment_size,omitempty"` // The maximum number of attempts at retransmitting a SYN packet before giving up. Allowed values are 3-8. MaxSynRetransmissions *int32 `json:"max_syn_retransmissions,omitempty"` // The minimum wait time (in millisec) to retransmit packet. Allowed values are 50-5000. Field introduced in 17.2.8. Unit is MILLISECONDS. MinRexmtTimeout *int32 `json:"min_rexmt_timeout,omitempty"` // Consolidates small data packets to send clients fewer but larger packets. Adversely affects real time protocols such as telnet or SSH. NaglesAlgorithm *bool `json:"nagles_algorithm,omitempty"` // Maximum number of TCP segments that can be queued for reassembly. Configuring this to 0 disables the feature and provides unlimited queuing. Field introduced in 17.2.13, 18.1.4, 18.2.1. ReassemblyQueueSize *int32 `json:"reassembly_queue_size,omitempty"` // Size of the receive window. Allowed values are 2-65536. Unit is KB. ReceiveWindow *int32 `json:"receive_window,omitempty"` // Controls the number of duplicate acks required to trigger retransmission. Setting a higher value reduces retransmission caused by packet reordering. A larger value is recommended in public cloud environments where packet reordering is quite common. The default value is 8 in public cloud platforms (AWS, Azure, GCP), and 3 in other environments. Allowed values are 1-100. Field introduced in 17.2.7. ReorderThreshold *int32 `json:"reorder_threshold,omitempty"` // Congestion window scaling factor during slow start. Allowed values are 0-8. Field introduced in 17.2.12, 18.1.3, 18.2.1. SlowStartScalingFactor *int32 `json:"slow_start_scaling_factor,omitempty"` // The time (in millisec) to wait before closing a connection in the TIME_WAIT state. Allowed values are 500-2000. Special values are 0 - 'immediate'. Unit is MILLISECONDS. TimeWaitDelay *int32 `json:"time_wait_delay,omitempty"` // Use the interface MTU to calculate the TCP max segment size. UseInterfaceMtu *bool `json:"use_interface_mtu,omitempty"` }
TCPProxyProfile TCP proxy profile swagger:model TCPProxyProfile
type TLSTicket ¶
type TLSTicket struct { // aes_key of TLSTicket. // Required: true AesKey *string `json:"aes_key"` // hmac_key of TLSTicket. // Required: true HmacKey *string `json:"hmac_key"` // Name of the object. // Required: true Name *string `json:"name"` }
TLSTicket TLS ticket swagger:model TLSTicket
type TacacsPlusAuthSettings ¶
type TacacsPlusAuthSettings struct { // TACACS+ authorization attribute value pairs. AuthorizationAttrs []*AuthTacacsPlusAttributeValuePair `json:"authorization_attrs,omitempty"` // TACACS+ server shared secret. Password *string `json:"password,omitempty"` // TACACS+ server listening port. Port *int32 `json:"port,omitempty"` // TACACS+ server IP address or FQDN. Minimum of 1 items required. Server []string `json:"server,omitempty"` // TACACS+ service. Enum options - AUTH_TACACS_PLUS_SERVICE_NONE, AUTH_TACACS_PLUS_SERVICE_LOGIN, AUTH_TACACS_PLUS_SERVICE_ENABLE, AUTH_TACACS_PLUS_SERVICE_PPP, AUTH_TACACS_PLUS_SERVICE_ARAP, AUTH_TACACS_PLUS_SERVICE_PT, AUTH_TACACS_PLUS_SERVICE_RCMD, AUTH_TACACS_PLUS_SERVICE_X25, AUTH_TACACS_PLUS_SERVICE_NASI, AUTH_TACACS_PLUS_SERVICE_FWPROXY. Service *string `json:"service,omitempty"` }
TacacsPlusAuthSettings tacacs plus auth settings swagger:model TacacsPlusAuthSettings
type Tag ¶
type Tag struct { // Enum options - AVI_DEFINED, USER_DEFINED, VCENTER_DEFINED. Type *string `json:"type,omitempty"` // value of Tag. // Required: true Value *string `json:"value"` }
Tag tag swagger:model Tag
type Tenant ¶
type Tenant struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Placeholder for description of property config_settings of obj type Tenant field type str type object ConfigSettings *TenantConfiguration `json:"config_settings,omitempty"` // Creator of this tenant. CreatedBy *string `json:"created_by,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Placeholder for description of property local of obj type Tenant field type str type boolean Local *bool `json:"local,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Suggestive pool of key value pairs for recommending assignment of labels to objects in the User Interface. Every entry is unique in both key and value. Field introduced in 20.1.2. Maximum of 256 items allowed. SuggestedObjectLabels []*TenantLabel `json:"suggested_object_labels,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
Tenant tenant swagger:model Tenant
type TenantAPIResponse ¶
type TenantAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Tenant `json:"results,omitempty"` }
TenantAPIResponse tenant Api response swagger:model TenantApiResponse
type TenantConfiguration ¶
type TenantConfiguration struct { // Controls the ownership of ServiceEngines. Service Engines can either be exclusively owned by each tenant or owned by the administrator and shared by all tenants. When ServiceEngines are owned by the administrator, each tenant can have either read access or no access to their Service Engines. SeInProviderContext *bool `json:"se_in_provider_context,omitempty"` // Placeholder for description of property tenant_access_to_provider_se of obj type TenantConfiguration field type str type boolean TenantAccessToProviderSe *bool `json:"tenant_access_to_provider_se,omitempty"` // When 'Per Tenant IP Domain' is selected, each tenant gets its own routing domain that is not shared with any other tenant. When 'Share IP Domain across all tenants' is selected, all tenants share the same routing domain. TenantVrf *bool `json:"tenant_vrf,omitempty"` }
TenantConfiguration tenant configuration swagger:model TenantConfiguration
type TenantLabel ¶
type TenantLabel struct { // Label key string. Field introduced in 20.1.2. // Required: true Key *string `json:"key"` // Label value string. Field introduced in 20.1.2. Value *string `json:"value,omitempty"` }
TenantLabel tenant label swagger:model TenantLabel
type TencentCredentials ¶
type TencentCredentials struct { // Tencent secret ID. Field introduced in 18.2.3. // Required: true SecretID *string `json:"secret_id"` // Tencent secret key. Field introduced in 18.2.3. // Required: true SecretKey *string `json:"secret_key"` }
TencentCredentials tencent credentials swagger:model TencentCredentials
type TencentSetup ¶
type TencentSetup struct { // Tencent Cloud id. Field introduced in 18.2.3. CcID *string `json:"cc_id,omitempty"` // Tencent error message. Field introduced in 18.2.3. ErrorString *string `json:"error_string,omitempty"` // Tencent Region id. Field introduced in 18.2.3. Region *string `json:"region,omitempty"` // Tencent VPC id. Field introduced in 18.2.3. VpcID *string `json:"vpc_id,omitempty"` }
TencentSetup tencent setup swagger:model TencentSetup
type TencentZoneNetwork ¶
type TencentZoneNetwork struct { // Availability zone. Field introduced in 18.2.3. // Required: true AvailabilityZone *string `json:"availability_zone"` // Usable networks for Virtual IP. If VirtualService does not specify a network and auto_allocate_ip is set, then the first available network from this list will be chosen for IP allocation. Field introduced in 18.2.3. // Required: true UsableSubnetID *string `json:"usable_subnet_id"` }
TencentZoneNetwork tencent zone network swagger:model TencentZoneNetwork
type TestSeDatastoreLevel1 ¶
type TestSeDatastoreLevel1 struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 18.2.6. TenantRef *string `json:"tenant_ref,omitempty"` // It is a reference to an object of type TestSeDatastoreLevel2. Field introduced in 18.2.6. TestSeDatastoreLevel2Ref *string `json:"test_se_datastore_level_2_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
TestSeDatastoreLevel1 test se datastore level1 swagger:model TestSeDatastoreLevel1
type TestSeDatastoreLevel1APIResponse ¶
type TestSeDatastoreLevel1APIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*TestSeDatastoreLevel1 `json:"results,omitempty"` }
TestSeDatastoreLevel1APIResponse test se datastore level1 Api response swagger:model TestSeDatastoreLevel1ApiResponse
type TestSeDatastoreLevel2 ¶
type TestSeDatastoreLevel2 struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 18.2.6. TenantRef *string `json:"tenant_ref,omitempty"` // It is a reference to an object of type TestSeDatastoreLevel3. Field introduced in 18.2.6. TestSeDatastoreLevel3Refs []string `json:"test_se_datastore_level_3_refs,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
TestSeDatastoreLevel2 test se datastore level2 swagger:model TestSeDatastoreLevel2
type TestSeDatastoreLevel2APIResponse ¶
type TestSeDatastoreLevel2APIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*TestSeDatastoreLevel2 `json:"results,omitempty"` }
TestSeDatastoreLevel2APIResponse test se datastore level2 Api response swagger:model TestSeDatastoreLevel2ApiResponse
type TestSeDatastoreLevel3 ¶
type TestSeDatastoreLevel3 struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 18.2.6. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
TestSeDatastoreLevel3 test se datastore level3 swagger:model TestSeDatastoreLevel3
type TestSeDatastoreLevel3APIResponse ¶
type TestSeDatastoreLevel3APIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*TestSeDatastoreLevel3 `json:"results,omitempty"` }
TestSeDatastoreLevel3APIResponse test se datastore level3 Api response swagger:model TestSeDatastoreLevel3ApiResponse
type Tier1LogicalRouterInfo ¶
type Tier1LogicalRouterInfo struct { // Segment ID. Field introduced in 20.1.1. // Required: true SegmentID *string `json:"segment_id"` // Tier1 logical router ID. Field introduced in 20.1.1. // Required: true Tier1LrID *string `json:"tier1_lr_id"` }
Tier1LogicalRouterInfo tier1 logical router info swagger:model Tier1LogicalRouterInfo
type TimeStamp ¶
type TimeStamp struct { // Number of secs. // Required: true Secs *int64 `json:"secs"` // Number of usecs. // Required: true Usecs *int64 `json:"usecs"` }
TimeStamp time stamp swagger:model TimeStamp
type TrafficCloneProfile ¶
type TrafficCloneProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Field introduced in 17.1.1. Maximum of 10 items allowed. CloneServers []*CloneServer `json:"clone_servers,omitempty"` // It is a reference to an object of type Cloud. Field introduced in 17.1.1. CloudRef *string `json:"cloud_ref,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name for the Traffic Clone Profile. Field introduced in 17.1.1. // Required: true Name *string `json:"name"` // Specifies if client IP needs to be preserved to clone destination. Field introduced in 17.1.1. PreserveClientIP *bool `json:"preserve_client_ip,omitempty"` // It is a reference to an object of type Tenant. Field introduced in 17.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the Traffic Clone Profile. Field introduced in 17.1.1. UUID *string `json:"uuid,omitempty"` }
TrafficCloneProfile traffic clone profile swagger:model TrafficCloneProfile
type TrafficCloneProfileAPIResponse ¶
type TrafficCloneProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*TrafficCloneProfile `json:"results,omitempty"` }
TrafficCloneProfileAPIResponse traffic clone profile Api response swagger:model TrafficCloneProfileApiResponse
type UDPFastPathProfile ¶
type UDPFastPathProfile struct { // DSR profile information. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. DsrProfile *DsrProfile `json:"dsr_profile,omitempty"` // When enabled, every UDP packet is considered a new transaction and may be load balanced to a different server. When disabled, packets from the same client source IP and port are sent to the same server. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. PerPktLoadbalance *bool `json:"per_pkt_loadbalance,omitempty"` // The amount of time (in sec) for which a flow needs to be idle before it is deleted. Allowed values are 2-3600. Unit is SEC. SessionIDLETimeout *int32 `json:"session_idle_timeout,omitempty"` // When disabled, Source NAT will not be performed for all client UDP packets. Snat *bool `json:"snat,omitempty"` }
UDPFastPathProfile UDP fast path profile swagger:model UDPFastPathProfile
type UDPProxyProfile ¶
type UDPProxyProfile struct { // The amount of time (in sec) for which a flow needs to be idle before it is deleted. Allowed values are 2-3600. Field introduced in 17.2.8, 18.1.3, 18.2.1. Unit is SEC. SessionIDLETimeout *int32 `json:"session_idle_timeout,omitempty"` }
UDPProxyProfile UDP proxy profile swagger:model UDPProxyProfile
type URIInfo ¶
type URIInfo struct { // Information about various params under a URI. Field introduced in 20.1.1. ParamInfo []*ParamInfo `json:"param_info,omitempty"` // Total number of URI hits. Field introduced in 20.1.1. URIHits *int64 `json:"uri_hits,omitempty"` // URI name. Field introduced in 20.1.1. URIKey *string `json:"uri_key,omitempty"` }
URIInfo URI info swagger:model URIInfo
type URIParam ¶
type URIParam struct { // Token config either for the URI components or a constant string. Minimum of 1 items required. Tokens []*URIParamToken `json:"tokens,omitempty"` // URI param type. Enum options - URI_PARAM_TYPE_TOKENIZED. // Required: true Type *string `json:"type"` }
URIParam URI param swagger:model URIParam
type URIParamQuery ¶
type URIParamQuery struct { // Concatenate a *string to the query of the incoming request URI and then use it in the request URI going to the backend server. AddString *string `json:"add_string,omitempty"` // Use or drop the query of the incoming request URI in the request URI to the backend server. KeepQuery *bool `json:"keep_query,omitempty"` }
URIParamQuery URI param query swagger:model URIParamQuery
type URIParamToken ¶
type URIParamToken struct { // Index of the ending token in the incoming URI. Allowed values are 0-65534. Special values are 65535 - 'end of string'. EndIndex *int32 `json:"end_index,omitempty"` // Index of the starting token in the incoming URI. StartIndex *int32 `json:"start_index,omitempty"` // Constant *string to use as a token. StrValue *string `json:"str_value,omitempty"` // Token type for constructing the URI. Enum options - URI_TOKEN_TYPE_HOST, URI_TOKEN_TYPE_PATH, URI_TOKEN_TYPE_STRING, URI_TOKEN_TYPE_STRING_GROUP, URI_TOKEN_TYPE_REGEX. // Required: true Type *string `json:"type"` }
URIParamToken URI param token swagger:model URIParamToken
type UpgradeEvent ¶
type UpgradeEvent struct { // Time taken to complete upgrade event in seconds. Field introduced in 18.2.6. Unit is SEC. Duration *int32 `json:"duration,omitempty"` // Task end time. Field introduced in 18.2.6. EndTime *string `json:"end_time,omitempty"` // Ip of the node. Field introduced in 18.2.6. IP *IPAddr `json:"ip,omitempty"` // Upgrade event message if any. Field introduced in 18.2.6. Message *string `json:"message,omitempty"` // Task start time. Field introduced in 18.2.6. StartTime *string `json:"start_time,omitempty"` // Upgrade event status. Field introduced in 18.2.6. Status *bool `json:"status,omitempty"` // Sub tasks executed on each node. Field introduced in 18.2.8, 20.1.1. SubTasks []string `json:"sub_tasks,omitempty"` }
UpgradeEvent upgrade event swagger:model UpgradeEvent
type UpgradeOpsEntry ¶
type UpgradeOpsEntry struct { // Name of the system such as cluster name, se group name and se name. Field introduced in 18.2.6. Name *string `json:"name,omitempty"` // Describes the system controller or se-group or se. Enum options - NODE_CONTROLLER_CLUSTER, NODE_SE_GROUP, NODE_SE_TYPE. Field introduced in 18.2.6. NodeType *string `json:"node_type,omitempty"` // Cloud that this object belongs to. It is a reference to an object of type Cloud. Field introduced in 18.2.6. ObjCloudRef *string `json:"obj_cloud_ref,omitempty"` // Parameters associated with the upgrade ops request. Field introduced in 18.2.6. Params *UpgradeOpsParam `json:"params,omitempty"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.6. TenantRef *string `json:"tenant_ref,omitempty"` // Current Upgrade Status info for this node. Field introduced in 18.2.6. UpgradeInfo *UpgradeStatusInfo `json:"upgrade_info,omitempty"` // Identifies the upgrade operations. Enum options - UPGRADE, PATCH, ROLLBACK, ROLLBACKPATCH, SEGROUP_RESUME. Field introduced in 18.2.6. UpgradeOps *string `json:"upgrade_ops,omitempty"` // Uuid identifier for the system such as cluster, se group and se. Field introduced in 18.2.6. UUID *string `json:"uuid,omitempty"` }
UpgradeOpsEntry upgrade ops entry swagger:model UpgradeOpsEntry
type UpgradeOpsParam ¶
type UpgradeOpsParam struct { // Image uuid for identifying base image. It is a reference to an object of type Image. Field introduced in 18.2.6. ImageRef *string `json:"image_ref,omitempty"` // Image uuid for identifying patch. It is a reference to an object of type Image. Field introduced in 18.2.6. PatchRef *string `json:"patch_ref,omitempty"` // This field identifies SE group options that need to be applied during the upgrade operations. Field introduced in 18.2.6. SeGroupOptions *SeGroupOptions `json:"se_group_options,omitempty"` // Apply options while resuming SE group upgrade operations. Field introduced in 18.2.6. SeGroupResumeOptions *SeGroupResumeOptions `json:"se_group_resume_options,omitempty"` }
UpgradeOpsParam upgrade ops param swagger:model UpgradeOpsParam
type UpgradeOpsState ¶
type UpgradeOpsState struct { // The last time the state changed. Field introduced in 18.2.6. LastChangedTime *TimeStamp `json:"last_changed_time,omitempty"` // Descriptive reason for the state-change. Field introduced in 18.2.6. Reason *string `json:"reason,omitempty"` // State for keeping track of reboot status during upgrade operation. Field introduced in 20.1.2. Allowed in Basic edition, Essentials edition, Enterprise edition. Rebooted *bool `json:"rebooted,omitempty"` // The upgrade operations current fsm-state. Enum options - UPGRADE_FSM_INIT, UPGRADE_FSM_STARTED, UPGRADE_FSM_WAITING, UPGRADE_FSM_IN_PROGRESS, UPGRADE_FSM_ENQUEUED, UPGRADE_FSM_ERROR, UPGRADE_FSM_SUSPENDED, UPGRADE_FSM_ENQUEUE_FAILED, UPGRADE_FSM_PAUSED, UPGRADE_FSM_COMPLETED, UPGRADE_FSM_ABORT_IN_PROGRESS, UPGRADE_FSM_ABORTED, UPGRADE_FSM_SE_UPGRADE_IN_PROGRESS, UPGRADE_FSM_CONTROLLER_COMPLETED, UPGRADE_FSM_DUMMY_3, UPGRADE_FSM_DUMMY_4, UPGRADE_FSM_DUMMY_5. Field introduced in 18.2.6. State *string `json:"state,omitempty"` }
UpgradeOpsState upgrade ops state swagger:model UpgradeOpsState
type UpgradeStatusInfo ¶
type UpgradeStatusInfo struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Backward compatible abort function name. Field introduced in 18.2.10, 20.1.1. AfterRebootRollbackFnc *string `json:"after_reboot_rollback_fnc,omitempty"` // Backward compatible task dict name. Field introduced in 18.2.10, 20.1.1. AfterRebootTaskName *string `json:"after_reboot_task_name,omitempty"` // Flag for clean installation. Field introduced in 18.2.10, 20.1.1. Clean *bool `json:"clean,omitempty"` // Duration of Upgrade operation in seconds. Field introduced in 18.2.6. Duration *int32 `json:"duration,omitempty"` // Check if the patch rollback is possible on this node. Field introduced in 18.2.6. EnablePatchRollback *bool `json:"enable_patch_rollback,omitempty"` // Check if the rollback is possible on this node. Field introduced in 18.2.6. EnableRollback *bool `json:"enable_rollback,omitempty"` // End time of Upgrade operation. Field introduced in 18.2.6. EndTime *string `json:"end_time,omitempty"` // Enqueue time of Upgrade operation. Field introduced in 18.2.6. EnqueueTime *string `json:"enqueue_time,omitempty"` // Record of past operations on this node. Field introduced in 20.1.4. History []*OpsHistory `json:"history,omitempty"` // Image path of current base image. Field introduced in 18.2.10, 20.1.1. ImagePath *string `json:"image_path,omitempty"` // Image uuid for identifying the current base image. It is a reference to an object of type Image. Field introduced in 18.2.6. ImageRef *string `json:"image_ref,omitempty"` // Name of the system such as cluster name, se group name and se name. Field introduced in 18.2.6. Name *string `json:"name,omitempty"` // Type of the system such as controller_cluster, se_group or se. Enum options - NODE_CONTROLLER_CLUSTER, NODE_SE_GROUP, NODE_SE_TYPE. Field introduced in 18.2.6. NodeType *string `json:"node_type,omitempty"` // Cloud that this object belongs to. It is a reference to an object of type Cloud. Field introduced in 18.2.6. ObjCloudRef *string `json:"obj_cloud_ref,omitempty"` // Parameters associated with the Upgrade operation. Field introduced in 18.2.6. Params *UpgradeOpsParam `json:"params,omitempty"` // Image path of current patch image. Field introduced in 18.2.10, 20.1.1. PatchImagePath *string `json:"patch_image_path,omitempty"` // Image uuid for identifying the current patch.Example Base-image is 18.2.6 and a patch 6p1 is applied, then this field will indicate the 6p1 value. . It is a reference to an object of type Image. Field introduced in 18.2.6. PatchImageRef *string `json:"patch_image_ref,omitempty"` // List of patches applied to this node. Example Base-image is 18.2.6 and a patch 6p1 is applied, then a patch 6p5 applied, this field will indicate the [{'6p1', '6p1_image_uuid'}, {'6p5', '6p5_image_uuid'}] value. Field introduced in 18.2.8, 20.1.1. PatchList []*PatchData `json:"patch_list,omitempty"` // Flag for patch op with reboot. Field introduced in 18.2.10, 20.1.1. PatchReboot *bool `json:"patch_reboot,omitempty"` // Current patch version applied to this node. Example Base-image is 18.2.6 and a patch 6p1 is applied, then this field will indicate the 6p1 value. . Field introduced in 18.2.6. PatchVersion *string `json:"patch_version,omitempty"` // Image path of previous base image. Field introduced in 18.2.10, 20.1.1. PrevImagePath *string `json:"prev_image_path,omitempty"` // Image path of previous patch image. Field introduced in 18.2.10, 20.1.1. PrevPatchImagePath *string `json:"prev_patch_image_path,omitempty"` // Image uuid for identifying previous base image.Example Base-image was 18.2.5 and an upgrade was done to 18.2.6, then this field will indicate the 18.2.5 value. . It is a reference to an object of type Image. Field introduced in 18.2.6. PreviousImageRef *string `json:"previous_image_ref,omitempty"` // Image uuid for identifying previous patch.Example Base-image was 18.2.6 with a patch 6p1. Upgrade was initiated to 18.2.8 with patch 8p1. The previous_image field will contain 18.2.6 and this field will indicate the 6p1 value. . It is a reference to an object of type Image. Field introduced in 18.2.6. PreviousPatchImageRef *string `json:"previous_patch_image_ref,omitempty"` // List of patches applied to this node on previous major version. Field introduced in 18.2.8, 20.1.1. PreviousPatchList []*PatchData `json:"previous_patch_list,omitempty"` // Previous patch version applied to this node.Example Base-image was 18.2.6 with a patch 6p1. Upgrade was initiated to 18.2.8 with patch 8p1. The previous_image field will contain 18.2.6 and this field will indicate the 6p1 value. . Field introduced in 18.2.6. PreviousPatchVersion *string `json:"previous_patch_version,omitempty"` // Previous version prior to upgrade.Example Base-image was 18.2.5 and an upgrade was done to 18.2.6, then this field will indicate the 18.2.5 value. . Field introduced in 18.2.6. PreviousVersion *string `json:"previous_version,omitempty"` // Upgrade operations progress which holds value between 0-100. Allowed values are 0-100. Field introduced in 18.2.8, 20.1.1. Unit is PERCENT. Progress *int32 `json:"progress,omitempty"` // Image path of se patch image.(required in case of reimage and upgrade + patch). Field introduced in 18.2.10, 20.1.1. SePatchImagePath *string `json:"se_patch_image_path,omitempty"` // Image uuid for identifying the current se patch required in case of system upgrade(re-image) with se patch. . It is a reference to an object of type Image. Field introduced in 18.2.10, 20.1.1. SePatchImageRef *string `json:"se_patch_image_ref,omitempty"` // ServiceEngineGroup upgrade errors. Field introduced in 18.2.6. SeUpgradeEvents []*SeUpgradeEvents `json:"se_upgrade_events,omitempty"` // se_patch may be different from the controller_patch. It has to be saved in the journal for subsequent consumption. The SeGroup params will be saved in the controller entry as seg_params. . Field introduced in 18.2.10, 20.1.1. SegParams *UpgradeOpsParam `json:"seg_params,omitempty"` // Detailed SeGroup status. Field introduced in 18.2.6. SegStatus *SeGroupStatus `json:"seg_status,omitempty"` // Start time of Upgrade operation. Field introduced in 18.2.6. StartTime *string `json:"start_time,omitempty"` // Current status of the Upgrade operation. Field introduced in 18.2.6. State *UpgradeOpsState `json:"state,omitempty"` // Flag is set only in the cluster if the upgrade is initiated as a system-upgrade. . Field introduced in 18.2.6. System *bool `json:"system,omitempty"` // Completed set of tasks in the Upgrade operation. Field introduced in 18.2.6. TasksCompleted *int32 `json:"tasks_completed,omitempty"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.6. TenantRef *string `json:"tenant_ref,omitempty"` // Total number of tasks in the Upgrade operation. Field introduced in 18.2.6. TotalTasks *int32 `json:"total_tasks,omitempty"` // Events performed for Upgrade operation. Field introduced in 18.2.6. UpgradeEvents []*EventMap `json:"upgrade_events,omitempty"` // Upgrade operations requested. Enum options - UPGRADE, PATCH, ROLLBACK, ROLLBACKPATCH, SEGROUP_RESUME. Field introduced in 18.2.6. UpgradeOps *string `json:"upgrade_ops,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID Identifier for the system such as cluster, se group and se. Field introduced in 18.2.6. UUID *string `json:"uuid,omitempty"` // Current base image applied to this node. Field introduced in 18.2.6. Version *string `json:"version,omitempty"` }
UpgradeStatusInfo upgrade status info swagger:model UpgradeStatusInfo
type UpgradeStatusInfoAPIResponse ¶
type UpgradeStatusInfoAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*UpgradeStatusInfo `json:"results,omitempty"` }
UpgradeStatusInfoAPIResponse upgrade status info Api response swagger:model UpgradeStatusInfoApiResponse
type UpgradeStatusSummary ¶
type UpgradeStatusSummary struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Check if the patch rollback is possible on this node. Field introduced in 18.2.6. EnablePatchRollback *bool `json:"enable_patch_rollback,omitempty"` // Check if the rollback is possible on this node. Field introduced in 18.2.6. EnableRollback *bool `json:"enable_rollback,omitempty"` // End time of upgrade operations. Field introduced in 18.2.6. EndTime *string `json:"end_time,omitempty"` // Image uuid for identifying the current base image. It is a reference to an object of type Image. Field introduced in 18.2.6. ImageRef *string `json:"image_ref,omitempty"` // Name of the system such as cluster name, se group name and se name. Field introduced in 18.2.6. Name *string `json:"name,omitempty"` // Type of the system such as controller_cluster, se_group or se. Enum options - NODE_CONTROLLER_CLUSTER, NODE_SE_GROUP, NODE_SE_TYPE. Field introduced in 18.2.6. NodeType *string `json:"node_type,omitempty"` // Cloud that this object belongs to. It is a reference to an object of type Cloud. Field introduced in 18.2.6. ObjCloudRef *string `json:"obj_cloud_ref,omitempty"` // Image uuid for identifying the current patch. It is a reference to an object of type Image. Field introduced in 18.2.6. PatchImageRef *string `json:"patch_image_ref,omitempty"` // Start time of upgrade operations. Field introduced in 18.2.6. StartTime *string `json:"start_time,omitempty"` // Current status of the upgrade operations. Field introduced in 18.2.6. State *UpgradeOpsState `json:"state,omitempty"` // Upgrade tasks completed. Field introduced in 18.2.6. TasksCompleted *int32 `json:"tasks_completed,omitempty"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.6. TenantRef *string `json:"tenant_ref,omitempty"` // Total upgrade tasks. Field introduced in 18.2.6. TotalTasks *int32 `json:"total_tasks,omitempty"` // Upgrade operations requested. Enum options - UPGRADE, PATCH, ROLLBACK, ROLLBACKPATCH, SEGROUP_RESUME. Field introduced in 18.2.6. UpgradeOps *string `json:"upgrade_ops,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID Identifier for the system such as cluster, se group and se. Field introduced in 18.2.6. UUID *string `json:"uuid,omitempty"` // Current base image applied to this node. Field introduced in 18.2.6. Version *string `json:"version,omitempty"` }
UpgradeStatusSummary upgrade status summary swagger:model UpgradeStatusSummary
type UpgradeStatusSummaryAPIResponse ¶
type UpgradeStatusSummaryAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*UpgradeStatusSummary `json:"results,omitempty"` }
UpgradeStatusSummaryAPIResponse upgrade status summary Api response swagger:model UpgradeStatusSummaryApiResponse
type UpgradeTask ¶
type UpgradeTask struct { // duration of UpgradeTask. Duration *string `json:"duration,omitempty"` // end_time of UpgradeTask. EndTime *string `json:"end_time,omitempty"` // start_time of UpgradeTask. StartTime *string `json:"start_time,omitempty"` // Enum options - PREPARE_FOR_SHUTDOWN. COPY_AND_VERIFY_IMAGE. INSTALL_IMAGE. POST_INSTALL_HOOKS. PREPARE_CONTROLLER_FOR_SHUTDOWN. STOP_CONTROLLER. EXTRACT_PATCH_IMAGE. EXECUTE_PRE_INSTALL_COMMANDS. INSTALL_PATCH_IMAGE. PREPARE_FOR_REBOOT_CONTROLLER_NODES. REBOOT_CONTROLLER_NODES. WAIT_FOR_ALL_CONTROLLER_NODES_ONLINE. PRE_UPGRADE_HOOKS. MIGRATE_CONFIG. START_PRIMARY_CONTROLLER. START_ALL_CONTROLLERS. POST_UPGRADE_HOOKS. EXECUTE_POST_INSTALL_COMMANDS. SET_CONTROLLER_UPGRADE_COMPLETED. STATE_NOT_USED_IN_V2... Task *string `json:"task,omitempty"` }
UpgradeTask upgrade task swagger:model UpgradeTask
type User ¶
type User struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Placeholder for description of property access of obj type User field type str type object Access []*UserRole `json:"access,omitempty"` // It is a reference to an object of type Tenant. DefaultTenantRef *string `json:"default_tenant_ref,omitempty"` // email of User. Email *string `json:"email,omitempty"` // full_name of User. FullName *string `json:"full_name,omitempty"` // Placeholder for description of property is_superuser of obj type User field type str type boolean IsSuperuser *bool `json:"is_superuser,omitempty"` // Placeholder for description of property local of obj type User field type str type boolean Local *bool `json:"local,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // password of User. Password *string `json:"password,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // It is a reference to an object of type UserAccountProfile. UserProfileRef *string `json:"user_profile_ref,omitempty"` // username of User. Username *string `json:"username,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
User user swagger:model User
type UserAPIResponse ¶
type UserAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*User `json:"results,omitempty"` }
UserAPIResponse user Api response swagger:model UserApiResponse
type UserAccountProfile ¶
type UserAccountProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Lock timeout period (in minutes). Default is 30 minutes. Unit is MIN. AccountLockTimeout *int32 `json:"account_lock_timeout,omitempty"` // The time period after which credentials expire. Default is 180 days. Unit is DAYS. CredentialsTimeoutThreshold *int32 `json:"credentials_timeout_threshold,omitempty"` // Maximum number of concurrent sessions allowed. There are unlimited sessions by default. MaxConcurrentSessions *int32 `json:"max_concurrent_sessions,omitempty"` // Number of login attempts before lockout. Default is 3 attempts. Allowed values are 3-20. Special values are 0 - 'Unlimited login attempts allowed.'. MaxLoginFailureCount *int32 `json:"max_login_failure_count,omitempty"` // Maximum number of passwords to be maintained in the password history. Default is 4 passwords. MaxPasswordHistoryCount *int32 `json:"max_password_history_count,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
UserAccountProfile user account profile swagger:model UserAccountProfile
type UserAccountProfileAPIResponse ¶
type UserAccountProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*UserAccountProfile `json:"results,omitempty"` }
UserAccountProfileAPIResponse user account profile Api response swagger:model UserAccountProfileApiResponse
type UserActivity ¶
type UserActivity struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Number of concurrent user sessions open. ConcurrentSessions *int32 `json:"concurrent_sessions,omitempty"` // Number of failed login attempts before a successful login. FailedLoginAttempts *int32 `json:"failed_login_attempts,omitempty"` // IP of the machine the user was last logged in from. LastLoginIP *string `json:"last_login_ip,omitempty"` // Timestamp of last login. LastLoginTimestamp *string `json:"last_login_timestamp,omitempty"` // Timestamp of last password update. LastPasswordUpdate *string `json:"last_password_update,omitempty"` // Indicates whether the user is logged in or not. LoggedIn *bool `json:"logged_in,omitempty"` // Name of the user this object refers to. Name *string `json:"name,omitempty"` // Stores the previous n passwords where n is ControllerProperties.max_password_history_count. . PreviousPassword []string `json:"previous_password,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
UserActivity user activity swagger:model UserActivity
type UserActivityAPIResponse ¶
type UserActivityAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*UserActivity `json:"results,omitempty"` }
UserActivityAPIResponse user activity Api response swagger:model UserActivityApiResponse
type UserRole ¶
type UserRole struct { // Placeholder for description of property all_tenants of obj type UserRole field type str type boolean AllTenants *bool `json:"all_tenants,omitempty"` // Reference to the Object Access Policy that defines a User's access in the corresponding Tenant. It is a reference to an object of type ObjectAccessPolicy. Field deprecated in 20.1.2. Field introduced in 18.2.7, 20.1.1. ObjectAccessPolicyRef *string `json:"object_access_policy_ref,omitempty"` // It is a reference to an object of type Role. RoleRef *string `json:"role_ref,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` }
UserRole user role swagger:model UserRole
type VCASetup ¶
type VCASetup struct { // cc_id of VCASetup. CcID *string `json:"cc_id,omitempty"` // error_string of VCASetup. ErrorString *string `json:"error_string,omitempty"` // instance of VCASetup. // Required: true Instance *string `json:"instance"` // Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Privilege *string `json:"privilege,omitempty"` // username of VCASetup. Username *string `json:"username,omitempty"` }
VCASetup v c a setup swagger:model VCASetup
type VCenterConfiguration ¶
type VCenterConfiguration struct { // Datacenter for virtual infrastructure discovery. Datacenter *string `json:"datacenter,omitempty"` // Management subnet to use for Avi Service Engines. ManagementIPSubnet *IPAddrPrefix `json:"management_ip_subnet,omitempty"` // Management network to use for Avi Service Engines. It is a reference to an object of type VIMgrNWRuntime. ManagementNetwork *string `json:"management_network,omitempty"` // The password Avi Vantage will use when authenticating with vCenter. Password *string `json:"password,omitempty"` // Set the access mode to vCenter as either Read, which allows Avi to discover networks and servers, or Write, which also allows Avi to create Service Engines and configure their network properties. Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. // Required: true Privilege *string `json:"privilege"` // The username Avi Vantage will use when authenticating with vCenter. Username *string `json:"username,omitempty"` // Avi Service Engine Template in vCenter to be used for creating Service Engines. VcenterTemplateSeLocation *string `json:"vcenter_template_se_location,omitempty"` // vCenter hostname or IP address. VcenterURL *string `json:"vcenter_url,omitempty"` }
VCenterConfiguration v center configuration swagger:model vCenterConfiguration
type VCenterCredentials ¶
type VCenterCredentials struct { // Password to talk to VCenter server. Field introduced in 20.1.1. Password *string `json:"password,omitempty"` // Username to talk to VCenter server. Field introduced in 20.1.1. Username *string `json:"username,omitempty"` }
VCenterCredentials v center credentials swagger:model VCenterCredentials
type VCenterServer ¶
type VCenterServer struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // VCenter belongs to cloud. It is a reference to an object of type Cloud. Field introduced in 20.1.1. CloudRef *string `json:"cloud_ref,omitempty"` // VCenter template to create Service Engine. Field introduced in 20.1.1. // Required: true ContentLib *ContentLibConfig `json:"content_lib"` // Availabilty zone where VCenter list belongs to. Field introduced in 20.1.1. // Required: true Name *string `json:"name"` // VCenter belongs to tenant. It is a reference to an object of type Tenant. Field introduced in 20.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // VCenter config UUID. Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` // Credentials to access VCenter. It is a reference to an object of type CloudConnectorUser. Field introduced in 20.1.1. // Required: true VcenterCredentialsRef *string `json:"vcenter_credentials_ref"` // VCenter hostname or IP address. Field introduced in 20.1.1. // Required: true VcenterURL *string `json:"vcenter_url"` }
VCenterServer v center server swagger:model VCenterServer
type VCenterServerAPIResponse ¶
type VCenterServerAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VCenterServer `json:"results,omitempty"` }
VCenterServerAPIResponse v center server Api response swagger:model VCenterServerApiResponse
type VCloudAirConfiguration ¶
type VCloudAirConfiguration struct { // vCloudAir access mode. Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. // Required: true Privilege *string `json:"privilege"` // vCloudAir host address. // Required: true VcaHost *string `json:"vca_host"` // vCloudAir instance ID. // Required: true VcaInstance *string `json:"vca_instance"` // vCloudAir management network. // Required: true VcaMgmtNetwork *string `json:"vca_mgmt_network"` // vCloudAir orgnization ID. // Required: true VcaOrgnization *string `json:"vca_orgnization"` // vCloudAir password. // Required: true VcaPassword *string `json:"vca_password"` // vCloudAir username. // Required: true VcaUsername *string `json:"vca_username"` // vCloudAir virtual data center name. // Required: true VcaVdc *string `json:"vca_vdc"` }
VCloudAirConfiguration v cloud air configuration swagger:model vCloudAirConfiguration
type VHMatch ¶
type VHMatch struct { // Host/domain name match configuration. Must be configured along with at least one path match criteria. Field introduced in 20.1.3. // Required: true Host *string `json:"host"` // Resource/uri path match configuration. Must be configured along with Host match criteria. Field introduced in 20.1.3. Minimum of 1 items required. Path []*PathMatch `json:"path,omitempty"` }
VHMatch v h match swagger:model VHMatch
type VIAdminCredentials ¶
type VIAdminCredentials struct { // Name of the object. Name *string `json:"name,omitempty"` // password of VIAdminCredentials. Password *string `json:"password,omitempty"` // Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Privilege *string `json:"privilege,omitempty"` // vcenter_url of VIAdminCredentials. // Required: true VcenterURL *string `json:"vcenter_url"` // vi_mgr_token of VIAdminCredentials. ViMgrToken *string `json:"vi_mgr_token,omitempty"` }
VIAdminCredentials v i admin credentials swagger:model VIAdminCredentials
type VIControllerVnicInfo ¶
type VIControllerVnicInfo struct { // portgroup of VIControllerVnicInfo. // Required: true Portgroup *string `json:"portgroup"` // Placeholder for description of property vnic_ip of obj type VIControllerVnicInfo field type str type object VnicIP []*VIGuestvNicIPAddr `json:"vnic_ip,omitempty"` }
VIControllerVnicInfo v i controller vnic info swagger:model VIControllerVnicInfo
type VICreateSEReq ¶
type VICreateSEReq struct { // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` // cookie of VICreateSEReq. Cookie *string `json:"cookie,omitempty"` // Unique object identifier of se_grp. SeGrpUUID *string `json:"se_grp_uuid,omitempty"` // Placeholder for description of property se_params of obj type VICreateSEReq field type str type object // Required: true SeParams *VISeVMOvaParams `json:"se_params"` // Unique object identifier of tenant. TenantUUID *string `json:"tenant_uuid,omitempty"` // Placeholder for description of property vcenter_admin of obj type VICreateSEReq field type str type object VcenterAdmin *VIAdminCredentials `json:"vcenter_admin,omitempty"` // vcenter_vnic_portgroups of VICreateSEReq. VcenterVnicPortgroups []string `json:"vcenter_vnic_portgroups,omitempty"` }
VICreateSEReq v i create s e req swagger:model VICreateSEReq
type VIDCInfo ¶
type VIDCInfo struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // managed_object_id of VIDCInfo. // Required: true ManagedObjectID *string `json:"managed_object_id"` // Name of the object. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
VIDCInfo v ID c info swagger:model VIDCInfo
type VIDCInfoAPIResponse ¶
type VIDCInfoAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VIDCInfo `json:"results,omitempty"` }
VIDCInfoAPIResponse v ID c info Api response swagger:model VIDCInfoApiResponse
type VIFaultInjection ¶
type VIFaultInjection struct { // Enum options - INITIAL_VALUE. CREATE_SE. MODIFY_VNIC. VM_MONITOR. RESOURCE_MONITOR. PERF_MONITOR. SET_MGMT_IP. MODIFY_MGMT_IP. SIM_VM_BULK_NOTIF. RESYNC_ERROR. SIMULATE_OVA_ERR. VCENTER_NO_OBJECTS. CREATE_VM_RUNTIME_ERR. VERSION_NULL_ERR. INVALID_LOGIN. DISC_PGNAME_ERR. DISC_DCDETAILS_ERR. DISC_DC_ERR. DISC_HOST_ERR. DISC_CLUSTER_ERR... // Required: true API *string `json:"api"` // Field introduced in 17.1.3. CloudUUID *string `json:"cloud_uuid,omitempty"` // Number of count. // Required: true Count *int32 `json:"count"` // Field introduced in 17.1.3. NetworkUUID *string `json:"network_uuid,omitempty"` // Enum options - SEVM_SUCCESS. SEVM_CREATE_FAIL_NO_HW_INFO. SEVM_CREATE_FAIL_DUPLICATE_NAME. SEVM_CREATE_FAIL_NO_MGMT_NW. SEVM_CREATE_FAIL_NO_CPU. SEVM_CREATE_FAIL_NO_MEM. SEVM_CREATE_FAIL_NO_LEASE. SEVM_CREATE_FAIL_OVF_ERROR. SEVM_CREATE_NO_HOST_VM_NETWORK. SEVM_CREATE_FAIL_NO_PROGRESS. SEVM_CREATE_FAIL_ABORTED. SEVM_CREATE_FAILURE. SEVM_CREATE_FAIL_POWER_ON. SEVM_VNIC_NO_VM. SEVM_VNIC_MAC_ADDR_ERROR. SEVM_VNIC_FAILURE. SEVM_VNIC_NO_PG_PORTS. SEVM_DELETE_FAILURE. SEVM_CREATE_LIMIT_REACHED. SEVM_SET_MGMT_IP_FAILED... Status *string `json:"status,omitempty"` }
VIFaultInjection v i fault injection swagger:model VIFaultInjection
type VIGuestvNicIPAddr ¶
type VIGuestvNicIPAddr struct { // ip_addr of VIGuestvNicIPAddr. // Required: true IPAddr *string `json:"ip_addr"` // Number of mask. // Required: true Mask *int32 `json:"mask"` }
VIGuestvNicIPAddr v i guestv nic IP addr swagger:model VIGuestvNicIPAddr
type VIMgrClusterRuntime ¶
type VIMgrClusterRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // datacenter_managed_object_id of VIMgrClusterRuntime. DatacenterManagedObjectID *string `json:"datacenter_managed_object_id,omitempty"` // Unique object identifier of datacenter. DatacenterUUID *string `json:"datacenter_uuid,omitempty"` // It is a reference to an object of type VIMgrHostRuntime. HostRefs []string `json:"host_refs,omitempty"` // managed_object_id of VIMgrClusterRuntime. // Required: true ManagedObjectID *string `json:"managed_object_id"` // Name of the object. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
VIMgrClusterRuntime v i mgr cluster runtime swagger:model VIMgrClusterRuntime
type VIMgrClusterRuntimeAPIResponse ¶
type VIMgrClusterRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VIMgrClusterRuntime `json:"results,omitempty"` }
VIMgrClusterRuntimeAPIResponse v i mgr cluster runtime Api response swagger:model VIMgrClusterRuntimeApiResponse
type VIMgrControllerRuntime ¶
type VIMgrControllerRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Placeholder for description of property vnics of obj type VIMgrControllerRuntime field type str type object Vnics []*VIControllerVnicInfo `json:"vnics,omitempty"` }
VIMgrControllerRuntime v i mgr controller runtime swagger:model VIMgrControllerRuntime
type VIMgrControllerRuntimeAPIResponse ¶
type VIMgrControllerRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VIMgrControllerRuntime `json:"results,omitempty"` }
VIMgrControllerRuntimeAPIResponse v i mgr controller runtime Api response swagger:model VIMgrControllerRuntimeApiResponse
type VIMgrDCRuntime ¶
type VIMgrDCRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // It is a reference to an object of type VIMgrClusterRuntime. ClusterRefs []string `json:"cluster_refs,omitempty"` // It is a reference to an object of type VIMgrHostRuntime. HostRefs []string `json:"host_refs,omitempty"` // Placeholder for description of property interested_hosts of obj type VIMgrDCRuntime field type str type object InterestedHosts []*VIMgrInterestedEntity `json:"interested_hosts,omitempty"` // Placeholder for description of property interested_nws of obj type VIMgrDCRuntime field type str type object InterestedNws []*VIMgrInterestedEntity `json:"interested_nws,omitempty"` // Placeholder for description of property interested_vms of obj type VIMgrDCRuntime field type str type object InterestedVms []*VIMgrInterestedEntity `json:"interested_vms,omitempty"` // Number of inventory_state. InventoryState *int32 `json:"inventory_state,omitempty"` // managed_object_id of VIMgrDCRuntime. // Required: true ManagedObjectID *string `json:"managed_object_id"` // Name of the object. // Required: true Name *string `json:"name"` // It is a reference to an object of type VIMgrNWRuntime. NwRefs []string `json:"nw_refs,omitempty"` // Number of pending_vcenter_reqs. PendingVcenterReqs *int32 `json:"pending_vcenter_reqs,omitempty"` // It is a reference to an object of type VIMgrSEVMRuntime. SevmRefs []string `json:"sevm_refs,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Unique object identifier of vcenter. VcenterUUID *string `json:"vcenter_uuid,omitempty"` // It is a reference to an object of type VIMgrVMRuntime. VMRefs []string `json:"vm_refs,omitempty"` }
VIMgrDCRuntime v i mgr d c runtime swagger:model VIMgrDCRuntime
type VIMgrDCRuntimeAPIResponse ¶
type VIMgrDCRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VIMgrDCRuntime `json:"results,omitempty"` }
VIMgrDCRuntimeAPIResponse v i mgr d c runtime Api response swagger:model VIMgrDCRuntimeApiResponse
type VIMgrGuestNicRuntime ¶
type VIMgrGuestNicRuntime struct { // Placeholder for description of property avi_internal_network of obj type VIMgrGuestNicRuntime field type str type boolean AviInternalNetwork *bool `json:"avi_internal_network,omitempty"` // Placeholder for description of property connected of obj type VIMgrGuestNicRuntime field type str type boolean Connected *bool `json:"connected,omitempty"` // Placeholder for description of property del_pending of obj type VIMgrGuestNicRuntime field type str type boolean DelPending *bool `json:"del_pending,omitempty"` // Placeholder for description of property guest_ip of obj type VIMgrGuestNicRuntime field type str type object GuestIP []*VIMgrIPSubnetRuntime `json:"guest_ip,omitempty"` // label of VIMgrGuestNicRuntime. Label *string `json:"label,omitempty"` // mac_addr of VIMgrGuestNicRuntime. // Required: true MacAddr *string `json:"mac_addr"` // Placeholder for description of property mgmt_vnic of obj type VIMgrGuestNicRuntime field type str type boolean MgmtVnic *bool `json:"mgmt_vnic,omitempty"` // network_name of VIMgrGuestNicRuntime. NetworkName *string `json:"network_name,omitempty"` // Unique object identifier of network. NetworkUUID *string `json:"network_uuid,omitempty"` // Unique object identifier of os_port. OsPortUUID *string `json:"os_port_uuid,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. // Required: true Type *string `json:"type"` }
VIMgrGuestNicRuntime v i mgr guest nic runtime swagger:model VIMgrGuestNicRuntime
type VIMgrHostRuntime ¶
type VIMgrHostRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // cluster_name of VIMgrHostRuntime. ClusterName *string `json:"cluster_name,omitempty"` // Unique object identifier of cluster. ClusterUUID *string `json:"cluster_uuid,omitempty"` // Placeholder for description of property cntlr_accessible of obj type VIMgrHostRuntime field type str type boolean CntlrAccessible *bool `json:"cntlr_accessible,omitempty"` // connection_state of VIMgrHostRuntime. ConnectionState *string `json:"connection_state,omitempty"` // Number of cpu_hz. CPUHz *int64 `json:"cpu_hz,omitempty"` // Placeholder for description of property maintenance_mode of obj type VIMgrHostRuntime field type str type boolean MaintenanceMode *bool `json:"maintenance_mode,omitempty"` // managed_object_id of VIMgrHostRuntime. // Required: true ManagedObjectID *string `json:"managed_object_id"` // Number of mem. Mem *int64 `json:"mem,omitempty"` // mgmt_portgroup of VIMgrHostRuntime. MgmtPortgroup *string `json:"mgmt_portgroup,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Unique object identifiers of networks. NetworkUuids []string `json:"network_uuids,omitempty"` // Number of num_cpu_cores. NumCPUCores *int32 `json:"num_cpu_cores,omitempty"` // Number of num_cpu_packages. NumCPUPackages *int32 `json:"num_cpu_packages,omitempty"` // Number of num_cpu_threads. NumCPUThreads *int32 `json:"num_cpu_threads,omitempty"` // Placeholder for description of property pnics of obj type VIMgrHostRuntime field type str type object Pnics []*CdpLldpInfo `json:"pnics,omitempty"` // powerstate of VIMgrHostRuntime. Powerstate *string `json:"powerstate,omitempty"` // quarantine_start_ts of VIMgrHostRuntime. QuarantineStartTs *string `json:"quarantine_start_ts,omitempty"` // Placeholder for description of property quarantined of obj type VIMgrHostRuntime field type str type boolean Quarantined *bool `json:"quarantined,omitempty"` // Number of quarantined_periods. QuarantinedPeriods *int32 `json:"quarantined_periods,omitempty"` // Number of se_fail_cnt. SeFailCnt *int32 `json:"se_fail_cnt,omitempty"` // Number of se_success_cnt. SeSuccessCnt *int32 `json:"se_success_cnt,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // It is a reference to an object of type VIMgrVMRuntime. VMRefs []string `json:"vm_refs,omitempty"` }
VIMgrHostRuntime v i mgr host runtime swagger:model VIMgrHostRuntime
type VIMgrHostRuntimeAPIResponse ¶
type VIMgrHostRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VIMgrHostRuntime `json:"results,omitempty"` }
VIMgrHostRuntimeAPIResponse v i mgr host runtime Api response swagger:model VIMgrHostRuntimeApiResponse
type VIMgrIPSubnetRuntime ¶
type VIMgrIPSubnetRuntime struct { // If true, capable of floating/elastic IP association. FipAvailable *bool `json:"fip_available,omitempty"` // If fip_available is True, this is list of supported FIP subnets, possibly empty if Cloud does not support such a network list. FipSubnetUuids []string `json:"fip_subnet_uuids,omitempty"` // If fip_available is True, the list of associated FloatingIP subnets, possibly empty if unsupported or implictly defined by the Cloud. Field introduced in 17.2.1. FloatingipSubnets []*FloatingIPSubnet `json:"floatingip_subnets,omitempty"` // ip_subnet of VIMgrIPSubnetRuntime. IPSubnet *string `json:"ip_subnet,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Placeholder for description of property prefix of obj type VIMgrIPSubnetRuntime field type str type object // Required: true Prefix *IPAddrPrefix `json:"prefix"` // True if prefix is primary IP on interface, else false. Primary *bool `json:"primary,omitempty"` // Number of ref_count. RefCount *int32 `json:"ref_count,omitempty"` // Number of se_ref_count. SeRefCount *int32 `json:"se_ref_count,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
VIMgrIPSubnetRuntime v i mgr IP subnet runtime swagger:model VIMgrIPSubnetRuntime
type VIMgrInterestedEntity ¶
type VIMgrInterestedEntity struct { // Unique object identifier of interested. // Required: true InterestedUUID *string `json:"interested_uuid"` }
VIMgrInterestedEntity v i mgr interested entity swagger:model VIMgrInterestedEntity
type VIMgrNWRuntime ¶
type VIMgrNWRuntime struct { // Placeholder for description of property MgmtNW of obj type VIMgrNWRuntime field type str type boolean MgmtNW *bool `json:"MgmtNW,omitempty"` // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // apic_vrf_context of VIMgrNWRuntime. ApicVrfContext *string `json:"apic_vrf_context,omitempty"` // Placeholder for description of property auto_expand of obj type VIMgrNWRuntime field type str type boolean AutoExpand *bool `json:"auto_expand,omitempty"` // availability_zone of VIMgrNWRuntime. AvailabilityZone *string `json:"availability_zone,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // Unique object identifier of datacenter. DatacenterUUID *string `json:"datacenter_uuid,omitempty"` // Placeholder for description of property dvs of obj type VIMgrNWRuntime field type str type boolean Dvs *bool `json:"dvs,omitempty"` // It is a reference to an object of type VIMgrHostRuntime. HostRefs []string `json:"host_refs,omitempty"` // Placeholder for description of property interested_nw of obj type VIMgrNWRuntime field type str type boolean InterestedNw *bool `json:"interested_nw,omitempty"` // Placeholder for description of property ip_subnet of obj type VIMgrNWRuntime field type str type object IPSubnet []*VIMgrIPSubnetRuntime `json:"ip_subnet,omitempty"` // managed_object_id of VIMgrNWRuntime. // Required: true ManagedObjectID *string `json:"managed_object_id"` // Name of the object. // Required: true Name *string `json:"name"` // Number of num_ports. NumPorts *int32 `json:"num_ports,omitempty"` // switch_name of VIMgrNWRuntime. SwitchName *string `json:"switch_name,omitempty"` // tenant_name of VIMgrNWRuntime. TenantName *string `json:"tenant_name,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Number of vlan. Vlan *int32 `json:"vlan,omitempty"` // Placeholder for description of property vlan_range of obj type VIMgrNWRuntime field type str type object VlanRange []*VlanRange `json:"vlan_range,omitempty"` // It is a reference to an object of type VIMgrVMRuntime. VMRefs []string `json:"vm_refs,omitempty"` // It is a reference to an object of type VrfContext. VrfContextRef *string `json:"vrf_context_ref,omitempty"` }
VIMgrNWRuntime v i mgr n w runtime swagger:model VIMgrNWRuntime
type VIMgrNWRuntimeAPIResponse ¶
type VIMgrNWRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VIMgrNWRuntime `json:"results,omitempty"` }
VIMgrNWRuntimeAPIResponse v i mgr n w runtime Api response swagger:model VIMgrNWRuntimeApiResponse
type VIMgrSEVMRuntime ¶
type VIMgrSEVMRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // availability_zone of VIMgrSEVMRuntime. AvailabilityZone *string `json:"availability_zone,omitempty"` // Field introduced in 17.2.1. AzureInfo *AzureInfo `json:"azure_info,omitempty"` // cloud_name of VIMgrSEVMRuntime. CloudName *string `json:"cloud_name,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // connection_state of VIMgrSEVMRuntime. ConnectionState *string `json:"connection_state,omitempty"` // Unique object identifier of controller_cluster. ControllerClusterUUID *string `json:"controller_cluster_uuid,omitempty"` // controller_ip_addr of VIMgrSEVMRuntime. ControllerIPAddr *string `json:"controller_ip_addr,omitempty"` // Service Engine Cookie set by the resource manager. Field introduced in 18.2.2. Cookie *string `json:"cookie,omitempty"` // Placeholder for description of property creation_in_progress of obj type VIMgrSEVMRuntime field type str type boolean CreationInProgress *bool `json:"creation_in_progress,omitempty"` // Placeholder for description of property deletion_in_progress of obj type VIMgrSEVMRuntime field type str type boolean DeletionInProgress *bool `json:"deletion_in_progress,omitempty"` // discovery_response of VIMgrSEVMRuntime. DiscoveryResponse *string `json:"discovery_response,omitempty"` // Number of discovery_status. DiscoveryStatus *int32 `json:"discovery_status,omitempty"` // Disk space in GB for each service engine VM. Field introduced in 18.2.2. DiskGb *int32 `json:"disk_gb,omitempty"` // flavor of VIMgrSEVMRuntime. Flavor *string `json:"flavor,omitempty"` // Placeholder for description of property guest_nic of obj type VIMgrSEVMRuntime field type str type object GuestNic []*VIMgrGuestNicRuntime `json:"guest_nic,omitempty"` // host of VIMgrSEVMRuntime. Host *string `json:"host,omitempty"` // It is a reference to an object of type VIMgrHostRuntime. HostRef *string `json:"host_ref,omitempty"` // hostid of VIMgrSEVMRuntime. Hostid *string `json:"hostid,omitempty"` // Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Hypervisor *string `json:"hypervisor,omitempty"` // Number of init_vnics. InitVnics *int32 `json:"init_vnics,omitempty"` // Number of last_discovery. LastDiscovery *int32 `json:"last_discovery,omitempty"` // managed_object_id of VIMgrSEVMRuntime. // Required: true ManagedObjectID *string `json:"managed_object_id"` // Memory in MB for each service engine VM. Field introduced in 18.2.2. MemoryMb *int32 `json:"memory_mb,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // powerstate of VIMgrSEVMRuntime. Powerstate *string `json:"powerstate,omitempty"` // Unique object identifier of security_group. SecurityGroupUUID *string `json:"security_group_uuid,omitempty"` // It is a reference to an object of type ServiceEngineGroup. SegroupRef *string `json:"segroup_ref,omitempty"` // Unique object identifier of server_group. ServerGroupUUID *string `json:"server_group_uuid,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Unique object identifier of vcenter_datacenter. VcenterDatacenterUUID *string `json:"vcenter_datacenter_uuid,omitempty"` // ServiceEngine instance uuid from vCenter. Field introduced in 20.1.1. VcenterInstanceUUID *string `json:"vcenter_instance_uuid,omitempty"` // ServiceEngine belongs to VCenter. It is a reference to an object of type VCenterServer. Field introduced in 20.1.1. VcenterRef *string `json:"vcenter_ref,omitempty"` // vcenter_rm_cookie of VIMgrSEVMRuntime. VcenterRmCookie *string `json:"vcenter_rm_cookie,omitempty"` // Enum options - VIMGR_SE_NETWORK_ADMIN, VIMGR_SE_UNIFIED_ADMIN. VcenterSeType *string `json:"vcenter_se_type,omitempty"` // Placeholder for description of property vcenter_template_vm of obj type VIMgrSEVMRuntime field type str type boolean VcenterTemplateVM *bool `json:"vcenter_template_vm,omitempty"` // Service Engine deployed in vcenter. Field introduced in 20.1.1. VcenterURL *string `json:"vcenter_url,omitempty"` // vcenter_vAppName of VIMgrSEVMRuntime. VcenterVAppName *string `json:"vcenter_vAppName,omitempty"` // vcenter_vAppVendor of VIMgrSEVMRuntime. VcenterVAppVendor *string `json:"vcenter_vAppVendor,omitempty"` // Enum options - VMTYPE_SE_VM, VMTYPE_POOL_SRVR. VcenterVMType *string `json:"vcenter_vm_type,omitempty"` // Count of vcpus for each service engine VM. Field introduced in 18.2.2. Vcpus *int32 `json:"vcpus,omitempty"` }
VIMgrSEVMRuntime v i mgr s e VM runtime swagger:model VIMgrSEVMRuntime
type VIMgrSEVMRuntimeAPIResponse ¶
type VIMgrSEVMRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VIMgrSEVMRuntime `json:"results,omitempty"` }
VIMgrSEVMRuntimeAPIResponse v i mgr s e VM runtime Api response swagger:model VIMgrSEVMRuntimeApiResponse
type VIMgrVMRuntime ¶
type VIMgrVMRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // availability_zone of VIMgrVMRuntime. AvailabilityZone *string `json:"availability_zone,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // connection_state of VIMgrVMRuntime. ConnectionState *string `json:"connection_state,omitempty"` // Unique object identifier of controller_cluster. ControllerClusterUUID *string `json:"controller_cluster_uuid,omitempty"` // controller_ip_addr of VIMgrVMRuntime. ControllerIPAddr *string `json:"controller_ip_addr,omitempty"` // Placeholder for description of property controller_vm of obj type VIMgrVMRuntime field type str type boolean ControllerVM *bool `json:"controller_vm,omitempty"` // Number of cpu_reservation. CPUReservation *int64 `json:"cpu_reservation,omitempty"` CPUShares *int32 `json:"cpu_shares,omitempty"` // Placeholder for description of property creation_in_progress of obj type VIMgrVMRuntime field type str type boolean CreationInProgress *bool `json:"creation_in_progress,omitempty"` // Placeholder for description of property guest_nic of obj type VIMgrVMRuntime field type str type object GuestNic []*VIMgrGuestNicRuntime `json:"guest_nic,omitempty"` // host of VIMgrVMRuntime. Host *string `json:"host,omitempty"` // Number of init_vnics. InitVnics *int32 `json:"init_vnics,omitempty"` // managed_object_id of VIMgrVMRuntime. // Required: true ManagedObjectID *string `json:"managed_object_id"` MemShares *int32 `json:"mem_shares,omitempty"` // Number of memory. Memory *int64 `json:"memory,omitempty"` // Number of memory_reservation. MemoryReservation *int64 `json:"memory_reservation,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Number of num_cpu. NumCPU *int32 `json:"num_cpu,omitempty"` // Field introduced in 17.1.1,17.1.3. OvfAvisetypeField *string `json:"ovf_avisetype_field,omitempty"` // powerstate of VIMgrVMRuntime. Powerstate *string `json:"powerstate,omitempty"` // Number of se_ver. SeVer *int32 `json:"se_ver,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Unique object identifier of vcenter_datacenter. VcenterDatacenterUUID *string `json:"vcenter_datacenter_uuid,omitempty"` // vcenter_rm_cookie of VIMgrVMRuntime. VcenterRmCookie *string `json:"vcenter_rm_cookie,omitempty"` // Enum options - VIMGR_SE_NETWORK_ADMIN, VIMGR_SE_UNIFIED_ADMIN. VcenterSeType *string `json:"vcenter_se_type,omitempty"` // Placeholder for description of property vcenter_template_vm of obj type VIMgrVMRuntime field type str type boolean VcenterTemplateVM *bool `json:"vcenter_template_vm,omitempty"` // vcenter_vAppName of VIMgrVMRuntime. VcenterVAppName *string `json:"vcenter_vAppName,omitempty"` // vcenter_vAppVendor of VIMgrVMRuntime. VcenterVAppVendor *string `json:"vcenter_vAppVendor,omitempty"` // Enum options - VMTYPE_SE_VM, VMTYPE_POOL_SRVR. VcenterVMType *string `json:"vcenter_vm_type,omitempty"` // Placeholder for description of property vcenter_vnic_discovered of obj type VIMgrVMRuntime field type str type boolean VcenterVnicDiscovered *bool `json:"vcenter_vnic_discovered,omitempty"` // Number of vm_lb_weight. VMLbWeight *int32 `json:"vm_lb_weight,omitempty"` }
VIMgrVMRuntime v i mgr VM runtime swagger:model VIMgrVMRuntime
type VIMgrVMRuntimeAPIResponse ¶
type VIMgrVMRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VIMgrVMRuntime `json:"results,omitempty"` }
VIMgrVMRuntimeAPIResponse v i mgr VM runtime Api response swagger:model VIMgrVMRuntimeApiResponse
type VIMgrVcenterRuntime ¶
type VIMgrVcenterRuntime struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // api_version of VIMgrVcenterRuntime. APIVersion *string `json:"api_version,omitempty"` // Placeholder for description of property apic_mode of obj type VIMgrVcenterRuntime field type str type boolean ApicMode *bool `json:"apic_mode,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // It is a reference to an object of type VIMgrDCRuntime. DatacenterRefs []string `json:"datacenter_refs,omitempty"` // disc_end_time of VIMgrVcenterRuntime. DiscEndTime *string `json:"disc_end_time,omitempty"` // disc_start_time of VIMgrVcenterRuntime. DiscStartTime *string `json:"disc_start_time,omitempty"` // discovered_datacenter of VIMgrVcenterRuntime. DiscoveredDatacenter *string `json:"discovered_datacenter,omitempty"` // inventory_progress of VIMgrVcenterRuntime. InventoryProgress *string `json:"inventory_progress,omitempty"` // Enum options - VCENTER_DISCOVERY_BAD_CREDENTIALS, VCENTER_DISCOVERY_RETRIEVING_DC, VCENTER_DISCOVERY_WAITING_DC, VCENTER_DISCOVERY_RETRIEVING_NW, VCENTER_DISCOVERY_ONGOING, VCENTER_DISCOVERY_RESYNCING, VCENTER_DISCOVERY_COMPLETE, VCENTER_DISCOVERY_DELETING_VCENTER, VCENTER_DISCOVERY_FAILURE, VCENTER_DISCOVERY_COMPLETE_NO_MGMT_NW, VCENTER_DISCOVERY_COMPLETE_PER_TENANT_IP_ROUTE, VCENTER_DISCOVERY_MAKING_SE_OVA, VCENTER_DISCOVERY_RESYNC_FAILED, VCENTER_DISCOVERY_OBJECT_LIMIT_REACHED. InventoryState *string `json:"inventory_state,omitempty"` // management_network of VIMgrVcenterRuntime. ManagementNetwork *string `json:"management_network,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Number of num_clusters. NumClusters *int64 `json:"num_clusters,omitempty"` // Number of num_dcs. NumDcs *int64 `json:"num_dcs,omitempty"` // Number of num_hosts. NumHosts *int64 `json:"num_hosts,omitempty"` // Number of num_nws. NumNws *int64 `json:"num_nws,omitempty"` // Number of num_vcenter_req_pending. NumVcenterReqPending *int64 `json:"num_vcenter_req_pending,omitempty"` // Number of num_vms. NumVms *int64 `json:"num_vms,omitempty"` // password of VIMgrVcenterRuntime. // Required: true Password *string `json:"password"` // Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Privilege *string `json:"privilege,omitempty"` // Number of progress. Progress *int64 `json:"progress,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. // Required: true Type *string `json:"type"` // url // Read Only: true URL *string `json:"url,omitempty"` // username of VIMgrVcenterRuntime. // Required: true Username *string `json:"username"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Placeholder for description of property vcenter_connected of obj type VIMgrVcenterRuntime field type str type boolean VcenterConnected *bool `json:"vcenter_connected,omitempty"` // vcenter_fullname of VIMgrVcenterRuntime. VcenterFullname *string `json:"vcenter_fullname,omitempty"` // vcenter_template_se_location of VIMgrVcenterRuntime. VcenterTemplateSeLocation *string `json:"vcenter_template_se_location,omitempty"` // vcenter_url of VIMgrVcenterRuntime. // Required: true VcenterURL *string `json:"vcenter_url"` }
VIMgrVcenterRuntime v i mgr vcenter runtime swagger:model VIMgrVcenterRuntime
type VIMgrVcenterRuntimeAPIResponse ¶
type VIMgrVcenterRuntimeAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VIMgrVcenterRuntime `json:"results,omitempty"` }
VIMgrVcenterRuntimeAPIResponse v i mgr vcenter runtime Api response swagger:model VIMgrVcenterRuntimeApiResponse
type VIPGNameInfo ¶
type VIPGNameInfo struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // managed_object_id of VIPGNameInfo. // Required: true ManagedObjectID *string `json:"managed_object_id"` // Name of the object. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
VIPGNameInfo v IP g name info swagger:model VIPGNameInfo
type VIPGNameInfoAPIResponse ¶
type VIPGNameInfoAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VIPGNameInfo `json:"results,omitempty"` }
VIPGNameInfoAPIResponse v IP g name info Api response swagger:model VIPGNameInfoApiResponse
type VIRetrievePGNames ¶
type VIRetrievePGNames struct { // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` // datacenter of VIRetrievePGNames. Datacenter *string `json:"datacenter,omitempty"` // password of VIRetrievePGNames. Password *string `json:"password,omitempty"` // username of VIRetrievePGNames. Username *string `json:"username,omitempty"` // vcenter_url of VIRetrievePGNames. VcenterURL *string `json:"vcenter_url,omitempty"` }
VIRetrievePGNames v i retrieve p g names swagger:model VIRetrievePGNames
type VISeVMIPConfParams ¶
type VISeVMIPConfParams struct { // default_gw of VISeVmIpConfParams. DefaultGw *string `json:"default_gw,omitempty"` // mgmt_ip_addr of VISeVmIpConfParams. MgmtIPAddr *string `json:"mgmt_ip_addr,omitempty"` // Enum options - VNIC_IP_TYPE_DHCP, VNIC_IP_TYPE_STATIC. // Required: true MgmtIPType *string `json:"mgmt_ip_type"` // mgmt_net_mask of VISeVmIpConfParams. MgmtNetMask *string `json:"mgmt_net_mask,omitempty"` }
VISeVMIPConfParams v i se Vm Ip conf params swagger:model VISeVmIpConfParams
type VISeVMOvaParams ¶
type VISeVMOvaParams struct { // Unique object identifier of controller_cluster. ControllerClusterUUID *string `json:"controller_cluster_uuid,omitempty"` // controller_ip_addr of VISeVmOvaParams. // Required: true ControllerIPAddr *string `json:"controller_ip_addr"` // Enum options - APIC_MODE, NON_APIC_MODE. Mode *string `json:"mode,omitempty"` // rm_cookie of VISeVmOvaParams. RmCookie *string `json:"rm_cookie,omitempty"` // se_auth_token of VISeVmOvaParams. SeAuthToken *string `json:"se_auth_token,omitempty"` // sevm_name of VISeVmOvaParams. // Required: true SevmName *string `json:"sevm_name"` // Placeholder for description of property single_socket_affinity of obj type VISeVmOvaParams field type str type boolean SingleSocketAffinity *bool `json:"single_socket_affinity,omitempty"` // Placeholder for description of property vcenter_cpu_reserv of obj type VISeVmOvaParams field type str type boolean VcenterCPUReserv *bool `json:"vcenter_cpu_reserv,omitempty"` // Placeholder for description of property vcenter_ds_include of obj type VISeVmOvaParams field type str type boolean VcenterDsInclude *bool `json:"vcenter_ds_include,omitempty"` // Placeholder for description of property vcenter_ds_info of obj type VISeVmOvaParams field type str type object VcenterDsInfo []*VcenterDatastore `json:"vcenter_ds_info,omitempty"` // Enum options - VCENTER_DATASTORE_ANY, VCENTER_DATASTORE_LOCAL, VCENTER_DATASTORE_SHARED. VcenterDsMode *string `json:"vcenter_ds_mode,omitempty"` // vcenter_host of VISeVmOvaParams. VcenterHost *string `json:"vcenter_host,omitempty"` // vcenter_internal of VISeVmOvaParams. VcenterInternal *string `json:"vcenter_internal,omitempty"` // Placeholder for description of property vcenter_mem_reserv of obj type VISeVmOvaParams field type str type boolean VcenterMemReserv *bool `json:"vcenter_mem_reserv,omitempty"` // Number of vcenter_num_mem. VcenterNumMem *int64 `json:"vcenter_num_mem,omitempty"` // Number of vcenter_num_se_cores. VcenterNumSeCores *int32 `json:"vcenter_num_se_cores,omitempty"` // vcenter_opaque_nwid of VISeVmOvaParams. VcenterOpaqueNwid *string `json:"vcenter_opaque_nwid,omitempty"` // vcenter_ovf_path of VISeVmOvaParams. VcenterOvfPath *string `json:"vcenter_ovf_path,omitempty"` // Number of vcenter_se_disk_size_KB. VcenterSeDiskSizeKB *int32 `json:"vcenter_se_disk_size_KB,omitempty"` // vcenter_se_mgmt_nw of VISeVmOvaParams. VcenterSeMgmtNw *string `json:"vcenter_se_mgmt_nw,omitempty"` // vcenter_vm_folder of VISeVmOvaParams. VcenterVMFolder *string `json:"vcenter_vm_folder,omitempty"` }
VISeVMOvaParams v i se Vm ova params swagger:model VISeVmOvaParams
type VISetMgmtIPSEReq ¶
type VISetMgmtIPSEReq struct { // Placeholder for description of property admin of obj type VISetMgmtIpSEReq field type str type object Admin *VIAdminCredentials `json:"admin,omitempty"` // Placeholder for description of property all_vnic_connected of obj type VISetMgmtIpSEReq field type str type boolean AllVnicConnected *bool `json:"all_vnic_connected,omitempty"` // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` // Unique object identifier of dc. DcUUID *string `json:"dc_uuid,omitempty"` // Placeholder for description of property ip_params of obj type VISetMgmtIpSEReq field type str type object // Required: true IPParams *VISeVMIPConfParams `json:"ip_params"` // Placeholder for description of property power_on of obj type VISetMgmtIpSEReq field type str type boolean PowerOn *bool `json:"power_on,omitempty"` // rm_cookie of VISetMgmtIpSEReq. RmCookie *string `json:"rm_cookie,omitempty"` // Unique object identifier of sevm. // Required: true SevmUUID *string `json:"sevm_uuid"` }
VISetMgmtIPSEReq v i set mgmt Ip s e req swagger:model VISetMgmtIpSEReq
type VISetvNicNwReq ¶
type VISetvNicNwReq struct { // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` // Unique object identifier of dc. DcUUID *string `json:"dc_uuid,omitempty"` // rm_cookie of VISetvNicNwReq. RmCookie *string `json:"rm_cookie,omitempty"` // Unique object identifier of sevm. // Required: true SevmUUID *string `json:"sevm_uuid"` // Placeholder for description of property vcenter_admin of obj type VISetvNicNwReq field type str type object VcenterAdmin *VIAdminCredentials `json:"vcenter_admin,omitempty"` // vcenter_sevm_mor of VISetvNicNwReq. VcenterSevmMor *string `json:"vcenter_sevm_mor,omitempty"` // Placeholder for description of property vcenter_vnic_info of obj type VISetvNicNwReq field type str type object VcenterVnicInfo []*VIVMVnicInfo `json:"vcenter_vnic_info,omitempty"` }
VISetvNicNwReq v i setv nic nw req swagger:model VISetvNicNwReq
type VIVMVnicInfo ¶
type VIVMVnicInfo struct { // mac_addr of VIVmVnicInfo. // Required: true MacAddr *string `json:"mac_addr"` // vcenter_portgroup of VIVmVnicInfo. VcenterPortgroup *string `json:"vcenter_portgroup,omitempty"` // Enum options - VNIC_VSWITCH, VNIC_DVS. VcenterVnicNw *string `json:"vcenter_vnic_nw,omitempty"` }
VIVMVnicInfo v i Vm vnic info swagger:model VIVmVnicInfo
type VIdeleteNetworkFilter ¶
type VIdeleteNetworkFilter struct { // Field introduced in 17.1.3. CloudUUID *string `json:"cloud_uuid,omitempty"` // Field introduced in 17.1.3. Datacenter *string `json:"datacenter,omitempty"` // Field introduced in 17.1.3. NetworkUUID *string `json:"network_uuid,omitempty"` // Field introduced in 17.1.3. VcenterURL *string `json:"vcenter_url,omitempty"` }
VIdeleteNetworkFilter v idelete network filter swagger:model VIDeleteNetworkFilter
type VIdeleteSEReq ¶
type VIdeleteSEReq struct { // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` // Unique object identifier of segroup. SegroupUUID *string `json:"segroup_uuid,omitempty"` // Unique object identifier of sevm. // Required: true SevmUUID *string `json:"sevm_uuid"` // Placeholder for description of property vcenter_admin of obj type VIDeleteSEReq field type str type object VcenterAdmin *VIAdminCredentials `json:"vcenter_admin,omitempty"` }
VIdeleteSEReq v idelete s e req swagger:model VIDeleteSEReq
type VNIC ¶
type VNIC struct { // adapter of vNIC. Adapter *string `json:"adapter,omitempty"` // Field introduced in 17.2.7. AggregatorChgd *bool `json:"aggregator_chgd,omitempty"` // Placeholder for description of property can_se_dp_takeover of obj type vNIC field type str type boolean CanSeDpTakeover *bool `json:"can_se_dp_takeover,omitempty"` // Placeholder for description of property connected of obj type vNIC field type str type boolean Connected *bool `json:"connected,omitempty"` // Placeholder for description of property del_pending of obj type vNIC field type str type boolean DelPending *bool `json:"del_pending,omitempty"` // Delete this VNIC. Please confirm dp_deletion_done before removing the VNIC from the cloud. Field introduced in 18.2.5. DeleteVnic *bool `json:"delete_vnic,omitempty"` // Placeholder for description of property dhcp_enabled of obj type vNIC field type str type boolean DhcpEnabled *bool `json:"dhcp_enabled,omitempty"` // The VNIC has been cleaned up in the datapath. Field introduced in 18.2.3. DpDeletionDone *bool `json:"dp_deletion_done,omitempty"` // Placeholder for description of property enabled of obj type vNIC field type str type boolean Enabled *bool `json:"enabled,omitempty"` // if_name of vNIC. IfName *string `json:"if_name,omitempty"` // Enable IPv6 auto configuration. Field introduced in 18.1.1. Ip6AutocfgEnabled *bool `json:"ip6_autocfg_enabled,omitempty"` // Placeholder for description of property is_asm of obj type vNIC field type str type boolean IsAsm *bool `json:"is_asm,omitempty"` // Placeholder for description of property is_avi_internal_network of obj type vNIC field type str type boolean IsAviInternalNetwork *bool `json:"is_avi_internal_network,omitempty"` // Placeholder for description of property is_hsm of obj type vNIC field type str type boolean IsHsm *bool `json:"is_hsm,omitempty"` // Placeholder for description of property is_mgmt of obj type vNIC field type str type boolean IsMgmt *bool `json:"is_mgmt,omitempty"` // Placeholder for description of property is_portchannel of obj type vNIC field type str type boolean IsPortchannel *bool `json:"is_portchannel,omitempty"` // The link is operationally up. Field introduced in 18.2.8, 20.1.1. LinkUp *bool `json:"link_up,omitempty"` // linux_name of vNIC. LinuxName *string `json:"linux_name,omitempty"` // mac_address of vNIC. // Required: true MacAddress *string `json:"mac_address"` // Placeholder for description of property members of obj type vNIC field type str type object Members []*MemberInterface `json:"members,omitempty"` // Number of mtu. Mtu *int32 `json:"mtu,omitempty"` // network_name of vNIC. NetworkName *string `json:"network_name,omitempty"` // It is a reference to an object of type Network. NetworkRef *string `json:"network_ref,omitempty"` // pci_id of vNIC. PciID *string `json:"pci_id,omitempty"` // Unique object identifier of port. PortUUID *string `json:"port_uuid,omitempty"` // Number of vlan_id. VlanID *int32 `json:"vlan_id,omitempty"` // Placeholder for description of property vlan_interfaces of obj type vNIC field type str type object VlanInterfaces []*VlanInterface `json:"vlan_interfaces,omitempty"` // Placeholder for description of property vnic_networks of obj type vNIC field type str type object VnicNetworks []*VNICNetwork `json:"vnic_networks,omitempty"` // Number of vrf_id. VrfID *int32 `json:"vrf_id,omitempty"` // It is a reference to an object of type VrfContext. VrfRef *string `json:"vrf_ref,omitempty"` }
VNIC v n i c swagger:model vNIC
type VNICNetwork ¶
type VNICNetwork struct { // Placeholder for description of property ctlr_alloc of obj type vNICNetwork field type str type boolean CtlrAlloc *bool `json:"ctlr_alloc,omitempty"` // Placeholder for description of property ip of obj type vNICNetwork field type str type object // Required: true IP *IPAddrPrefix `json:"ip"` // Enum options - DHCP, STATIC, VIP, DOCKER_HOST. // Required: true Mode *string `json:"mode"` }
VNICNetwork v n i c network swagger:model vNICNetwork
type VSDataScript ¶
type VSDataScript struct { // Event triggering execution of datascript. Enum options - VS_DATASCRIPT_EVT_HTTP_REQ, VS_DATASCRIPT_EVT_HTTP_RESP, VS_DATASCRIPT_EVT_HTTP_RESP_DATA, VS_DATASCRIPT_EVT_HTTP_LB_FAILED, VS_DATASCRIPT_EVT_HTTP_REQ_DATA, VS_DATASCRIPT_EVT_HTTP_RESP_FAILED, VS_DATASCRIPT_EVT_HTTP_LB_DONE, VS_DATASCRIPT_EVT_HTTP_AUTH, VS_DATASCRIPT_EVT_HTTP_POST_AUTH, VS_DATASCRIPT_EVT_TCP_CLIENT_ACCEPT, VS_DATASCRIPT_EVT_SSL_HANDSHAKE_DONE, VS_DATASCRIPT_EVT_DNS_REQ, VS_DATASCRIPT_EVT_DNS_RESP, VS_DATASCRIPT_EVT_L4_REQUEST, VS_DATASCRIPT_EVT_L4_RESPONSE, VS_DATASCRIPT_EVT_MAX. Allowed in Basic(Allowed values- VS_DATASCRIPT_EVT_HTTP_REQ) edition, Enterprise edition. // Required: true Evt *string `json:"evt"` // Datascript to execute when the event triggers. // Required: true Script *string `json:"script"` }
VSDataScript v s data script swagger:model VSDataScript
type VSDataScriptSet ¶
type VSDataScriptSet struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Creator name. Field introduced in 17.1.11,17.2.4. CreatedBy *string `json:"created_by,omitempty"` // DataScripts to execute. Datascript []*VSDataScript `json:"datascript,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Geo Location Mapping Database used by this DataScriptSet. It is a reference to an object of type GeoDB. Field introduced in 21.1.1. GeoDbRef *string `json:"geo_db_ref,omitempty"` // IP reputation database that can be used by DataScript functions. It is a reference to an object of type IPReputationDB. Field introduced in 20.1.3. IPReputationDbRef *string `json:"ip_reputation_db_ref,omitempty"` // UUID of IP Groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type IpAddrGroup. IpgroupRefs []string `json:"ipgroup_refs,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name for the virtual service datascript collection. // Required: true Name *string `json:"name"` // UUID of pool groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type PoolGroup. PoolGroupRefs []string `json:"pool_group_refs,omitempty"` // UUID of pools that could be referred by VSDataScriptSet objects. It is a reference to an object of type Pool. PoolRefs []string `json:"pool_refs,omitempty"` // List of protocol parsers that could be referred by VSDataScriptSet objects. It is a reference to an object of type ProtocolParser. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. ProtocolParserRefs []string `json:"protocol_parser_refs,omitempty"` // The Rate Limit definitions needed for this DataScript. The name is composed of the Virtual Service name and the DataScript name. Field introduced in 18.2.9. Allowed in Basic edition, Essentials edition, Enterprise edition. RateLimiters []*RateLimiter `json:"rate_limiters,omitempty"` // UUID of String Groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type StringGroup. StringGroupRefs []string `json:"string_group_refs,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the virtual service datascript collection. UUID *string `json:"uuid,omitempty"` }
VSDataScriptSet v s data script set swagger:model VSDataScriptSet
type VSDataScriptSetAPIResponse ¶
type VSDataScriptSetAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VSDataScriptSet `json:"results,omitempty"` }
VSDataScriptSetAPIResponse v s data script set Api response swagger:model VSDataScriptSetApiResponse
type VSDataScripts ¶
type VSDataScripts struct { // Index of the virtual service datascript collection. // Required: true Index *int32 `json:"index"` // UUID of the virtual service datascript collection. It is a reference to an object of type VSDataScriptSet. // Required: true VsDatascriptSetRef *string `json:"vs_datascript_set_ref"` }
VSDataScripts v s data scripts swagger:model VSDataScripts
type VcenterCloudStatusReq ¶
type VcenterCloudStatusReq struct { // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` }
VcenterCloudStatusReq vcenter cloud status req swagger:model VcenterCloudStatusReq
type VcenterClusters ¶
type VcenterClusters struct { // It is a reference to an object of type VIMgrClusterRuntime. ClusterRefs []string `json:"cluster_refs,omitempty"` // Placeholder for description of property include of obj type VcenterClusters field type str type boolean Include *bool `json:"include,omitempty"` }
VcenterClusters vcenter clusters swagger:model VcenterClusters
type VcenterDatastore ¶
type VcenterDatastore struct { // datastore_name of VcenterDatastore. // Required: true DatastoreName *string `json:"datastore_name"` }
VcenterDatastore vcenter datastore swagger:model VcenterDatastore
type VcenterHosts ¶
type VcenterHosts struct { // It is a reference to an object of type VIMgrHostRuntime. HostRefs []string `json:"host_refs,omitempty"` // Placeholder for description of property include of obj type VcenterHosts field type str type boolean Include *bool `json:"include,omitempty"` }
VcenterHosts vcenter hosts swagger:model VcenterHosts
type VcenterInventoryDiagReq ¶
type VcenterInventoryDiagReq struct { // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` }
VcenterInventoryDiagReq vcenter inventory diag req swagger:model VcenterInventoryDiagReq
type VcenterLogin ¶
type VcenterLogin struct { // Unique object identifier of cloud. CloudUUID *string `json:"cloud_uuid,omitempty"` // password of VcenterLogin. Password *string `json:"password,omitempty"` // Number of start_ts. StartTs *int64 `json:"start_ts,omitempty"` // username of VcenterLogin. Username *string `json:"username,omitempty"` // vcenter_url of VcenterLogin. VcenterURL *string `json:"vcenter_url,omitempty"` }
VcenterLogin vcenter login swagger:model VcenterLogin
type VersionInfo ¶
type VersionInfo struct { // Identifies the datastore table . Field introduced in 17.2.7. DsName *string `json:"ds_name,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Enum options - GSLB_NONE, GSLB_CREATE, GSLB_UPDATE, GSLB_DELETE, GSLB_PURGE, GSLB_DECL. Ops *string `json:"ops,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
VersionInfo version info swagger:model VersionInfo
type VinfraCntlrHostUnreachableList ¶
type VinfraCntlrHostUnreachableList struct { // host_name of VinfraCntlrHostUnreachableList. HostName []string `json:"host_name,omitempty"` // vcenter of VinfraCntlrHostUnreachableList. // Required: true Vcenter *string `json:"vcenter"` }
VinfraCntlrHostUnreachableList vinfra cntlr host unreachable list swagger:model VinfraCntlrHostUnreachableList
type VinfraDiscSummaryDetails ¶
type VinfraDiscSummaryDetails struct { // Number of num_clusters. NumClusters *int64 `json:"num_clusters,omitempty"` // Number of num_dcs. NumDcs *int64 `json:"num_dcs,omitempty"` // Number of num_hosts. NumHosts *int64 `json:"num_hosts,omitempty"` // Number of num_nws. NumNws *int64 `json:"num_nws,omitempty"` // Number of num_vms. NumVms *int64 `json:"num_vms,omitempty"` // vcenter of VinfraDiscSummaryDetails. // Required: true Vcenter *string `json:"vcenter"` }
VinfraDiscSummaryDetails vinfra disc summary details swagger:model VinfraDiscSummaryDetails
type VinfraMgmtNwChangeDetails ¶
type VinfraMgmtNwChangeDetails struct { // existing_nw of VinfraMgmtNwChangeDetails. // Required: true ExistingNw *string `json:"existing_nw"` // new_nw of VinfraMgmtNwChangeDetails. // Required: true NewNw *string `json:"new_nw"` // vcenter of VinfraMgmtNwChangeDetails. // Required: true Vcenter *string `json:"vcenter"` }
VinfraMgmtNwChangeDetails vinfra mgmt nw change details swagger:model VinfraMgmtNwChangeDetails
type VinfraPoolServerDeleteDetails ¶
type VinfraPoolServerDeleteDetails struct { // pool_name of VinfraPoolServerDeleteDetails. // Required: true PoolName *string `json:"pool_name"` // server_ip of VinfraPoolServerDeleteDetails. ServerIP []string `json:"server_ip,omitempty"` }
VinfraPoolServerDeleteDetails vinfra pool server delete details swagger:model VinfraPoolServerDeleteDetails
type VinfraVMDetails ¶
type VinfraVMDetails struct { // datacenter of VinfraVmDetails. Datacenter *string `json:"datacenter,omitempty"` // host of VinfraVmDetails. Host *string `json:"host,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` }
VinfraVMDetails vinfra Vm details swagger:model VinfraVmDetails
type VinfraVcenterBadCredentials ¶
type VinfraVcenterBadCredentials struct { // Name of the object. Name *string `json:"name,omitempty"` // Number of previous_count. PreviousCount *int64 `json:"previous_count,omitempty"` // user of VinfraVcenterBadCredentials. User *string `json:"user,omitempty"` // vcenter of VinfraVcenterBadCredentials. // Required: true Vcenter *string `json:"vcenter"` // vcenter_name of VinfraVcenterBadCredentials. VcenterName *string `json:"vcenter_name,omitempty"` // vcenter_object of VinfraVcenterBadCredentials. VcenterObject *string `json:"vcenter_object,omitempty"` }
VinfraVcenterBadCredentials vinfra vcenter bad credentials swagger:model VinfraVcenterBadCredentials
type VinfraVcenterConnectivityStatus ¶
type VinfraVcenterConnectivityStatus struct { // cloud of VinfraVcenterConnectivityStatus. // Required: true Cloud *string `json:"cloud"` // datacenter of VinfraVcenterConnectivityStatus. // Required: true Datacenter *string `json:"datacenter"` // vcenter of VinfraVcenterConnectivityStatus. // Required: true Vcenter *string `json:"vcenter"` }
VinfraVcenterConnectivityStatus vinfra vcenter connectivity status swagger:model VinfraVcenterConnectivityStatus
type VinfraVcenterDiscoveryFailure ¶
type VinfraVcenterDiscoveryFailure struct { // state of VinfraVcenterDiscoveryFailure. // Required: true State *string `json:"state"` // vcenter of VinfraVcenterDiscoveryFailure. // Required: true Vcenter *string `json:"vcenter"` }
VinfraVcenterDiscoveryFailure vinfra vcenter discovery failure swagger:model VinfraVcenterDiscoveryFailure
type VinfraVcenterNetworkLimit ¶
type VinfraVcenterNetworkLimit struct { // additional_reason of VinfraVcenterNetworkLimit. // Required: true AdditionalReason *string `json:"additional_reason"` // Number of current. // Required: true Current *int64 `json:"current"` // Number of limit. // Required: true Limit *int64 `json:"limit"` }
VinfraVcenterNetworkLimit vinfra vcenter network limit swagger:model VinfraVcenterNetworkLimit
type VinfraVcenterObjDeleteDetails ¶
type VinfraVcenterObjDeleteDetails struct { // obj_name of VinfraVcenterObjDeleteDetails. // Required: true ObjName *string `json:"obj_name"` // vcenter of VinfraVcenterObjDeleteDetails. // Required: true Vcenter *string `json:"vcenter"` }
VinfraVcenterObjDeleteDetails vinfra vcenter obj delete details swagger:model VinfraVcenterObjDeleteDetails
type Vip ¶
type Vip struct { // Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AutoAllocateFloatingIP *bool `json:"auto_allocate_floating_ip,omitempty"` // Auto-allocate VIP from the provided subnet. Field introduced in 17.1.1. AutoAllocateIP *bool `json:"auto_allocate_ip,omitempty"` // Specifies whether to auto-allocate only a V4 address, only a V6 address, or one of each type. Enum options - V4_ONLY, V6_ONLY, V4_V6. Field introduced in 18.1.1. Allowed in Basic(Allowed values- V4_ONLY) edition, Essentials(Allowed values- V4_ONLY) edition, Enterprise edition. AutoAllocateIPType *string `json:"auto_allocate_ip_type,omitempty"` // Availability-zone to place the Virtual Service. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. AvailabilityZone *string `json:"availability_zone,omitempty"` // (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AviAllocatedFip *bool `json:"avi_allocated_fip,omitempty"` // (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AviAllocatedVip *bool `json:"avi_allocated_vip,omitempty"` // Discovered networks providing reachability for client facing Vip IP. Field introduced in 17.1.1. DiscoveredNetworks []*DiscoveredNetwork `json:"discovered_networks,omitempty"` // Enable or disable the Vip. Field introduced in 17.1.1. Enabled *bool `json:"enabled,omitempty"` // Floating IPv4 to associate with this Vip. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. FloatingIP *IPAddr `json:"floating_ip,omitempty"` // Floating IPv6 address to associate with this Vip. Field introduced in 18.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. FloatingIp6 *IPAddr `json:"floating_ip6,omitempty"` // If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IPv6 address allocation. Field introduced in 18.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. FloatingSubnet6UUID *string `json:"floating_subnet6_uuid,omitempty"` // If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. FloatingSubnetUUID *string `json:"floating_subnet_uuid,omitempty"` // IPv6 Address of the Vip. Field introduced in 18.1.1. Ip6Address *IPAddr `json:"ip6_address,omitempty"` // IPv4 Address of the VIP. Field introduced in 17.1.1. IPAddress *IPAddr `json:"ip_address,omitempty"` // Subnet and/or Network for allocating VirtualService IP by IPAM Provider module. Field introduced in 17.1.1. IPAMNetworkSubnet *IPNetworkSubnet `json:"ipam_network_subnet,omitempty"` // Manually override the network on which the Vip is placed. It is a reference to an object of type Network. Field introduced in 17.1.1. NetworkRef *string `json:"network_ref,omitempty"` // Placement networks/subnets to use for vip placement. Field introduced in 18.2.5. Maximum of 10 items allowed. PlacementNetworks []*VipPlacementNetwork `json:"placement_networks,omitempty"` // (internal-use) Network port assigned to the Vip IP address. Field introduced in 17.1.1. PortUUID *string `json:"port_uuid,omitempty"` // Mask applied for the Vip, non-default mask supported only for wildcard Vip. Allowed values are 0-32. Field introduced in 20.1.1. Allowed in Basic(Allowed values- 32) edition, Essentials(Allowed values- 32) edition, Enterprise edition. PrefixLength *int32 `json:"prefix_length,omitempty"` // Subnet providing reachability for client facing Vip IP. Field introduced in 17.1.1. Subnet *IPAddrPrefix `json:"subnet,omitempty"` // Subnet providing reachability for client facing Vip IPv6. Field introduced in 18.1.1. Allowed in Essentials edition, Enterprise edition. Subnet6 *IPAddrPrefix `json:"subnet6,omitempty"` // If auto_allocate_ip is True, then the subnet for the Vip IPv6 address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 18.1.1. Allowed in Essentials edition, Enterprise edition. Subnet6UUID *string `json:"subnet6_uuid,omitempty"` // If auto_allocate_ip is True, then the subnet for the Vip IP address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 17.1.1. SubnetUUID *string `json:"subnet_uuid,omitempty"` // Unique ID associated with the vip. Field introduced in 17.1.1. // Required: true VipID *string `json:"vip_id"` }
Vip vip swagger:model Vip
type VipAutoscaleConfiguration ¶
type VipAutoscaleConfiguration struct { // This is the list of AZ+Subnet in which Vips will be spawned. Field introduced in 17.2.12, 18.1.2. Zones []*VipAutoscaleZones `json:"zones,omitempty"` }
VipAutoscaleConfiguration vip autoscale configuration swagger:model VipAutoscaleConfiguration
type VipAutoscaleGroup ¶
type VipAutoscaleGroup struct { // Field introduced in 17.2.12, 18.1.2. Configuration *VipAutoscaleConfiguration `json:"configuration,omitempty"` // Field introduced in 17.2.12, 18.1.2. Policy *VipAutoscalePolicy `json:"policy,omitempty"` }
VipAutoscaleGroup vip autoscale group swagger:model VipAutoscaleGroup
type VipAutoscalePolicy ¶
type VipAutoscalePolicy struct { // The amount of time, in seconds, when a Vip is withdrawn before a scaling activity starts. Field introduced in 17.2.12, 18.1.2. Unit is SECONDS. DNSCooldown *int32 `json:"dns_cooldown,omitempty"` // The maximum size of the group. Field introduced in 17.2.12, 18.1.2. MaxSize *int32 `json:"max_size,omitempty"` // The minimum size of the group. Field introduced in 17.2.12, 18.1.2. MinSize *int32 `json:"min_size,omitempty"` // When set, scaling is suspended. Field introduced in 17.2.12, 18.1.2. Suspend *bool `json:"suspend,omitempty"` }
VipAutoscalePolicy vip autoscale policy swagger:model VipAutoscalePolicy
type VipAutoscaleZones ¶
type VipAutoscaleZones struct { // Availability zone associated with the subnet. Field introduced in 17.2.12, 18.1.2. // Read Only: true AvailabilityZone *string `json:"availability_zone,omitempty"` // Determines if the subnet is capable of hosting publicly accessible IP. Field introduced in 17.2.12, 18.1.2. // Read Only: true FipCapable *bool `json:"fip_capable,omitempty"` // UUID of the subnet for new IP address allocation. Field introduced in 17.2.12, 18.1.2. SubnetUUID *string `json:"subnet_uuid,omitempty"` }
VipAutoscaleZones vip autoscale zones swagger:model VipAutoscaleZones
type VipPlacementNetwork ¶
type VipPlacementNetwork struct { // Network to use for vip placement. It is a reference to an object of type Network. Field introduced in 18.2.5. NetworkRef *string `json:"network_ref,omitempty"` // IPv4 Subnet to use for vip placement. Field introduced in 18.2.5. Subnet *IPAddrPrefix `json:"subnet,omitempty"` // IPv6 subnet to use for vip placement. Field introduced in 18.2.5. Subnet6 *IPAddrPrefix `json:"subnet6,omitempty"` }
VipPlacementNetwork vip placement network swagger:model VipPlacementNetwork
type VipPlacementResolutionInfo ¶
type VipPlacementResolutionInfo struct { // Placeholder for description of property ip of obj type VipPlacementResolutionInfo field type str type object IP *IPAddr `json:"ip,omitempty"` // Placeholder for description of property networks of obj type VipPlacementResolutionInfo field type str type object Networks []*DiscoveredNetwork `json:"networks,omitempty"` // Unique object identifier of pool. PoolUUID *string `json:"pool_uuid,omitempty"` }
VipPlacementResolutionInfo vip placement resolution info swagger:model VipPlacementResolutionInfo
type VipRuntime ¶
type VipRuntime struct { // ev of VipRuntime. Ev []string `json:"ev,omitempty"` // Placeholder for description of property ev_status of obj type VipRuntime field type str type object EvStatus *VsEvStatus `json:"ev_status,omitempty"` // Placeholder for description of property first_se_assigned_time of obj type VipRuntime field type str type object FirstSeAssignedTime *TimeStamp `json:"first_se_assigned_time,omitempty"` // Placeholder for description of property first_time_placement of obj type VipRuntime field type str type boolean FirstTimePlacement *bool `json:"first_time_placement,omitempty"` // fsm_state_id of VipRuntime. FsmStateID *string `json:"fsm_state_id,omitempty"` // fsm_state_name of VipRuntime. FsmStateName *string `json:"fsm_state_name,omitempty"` // Placeholder for description of property last_changed_time of obj type VipRuntime field type str type object LastChangedTime *TimeStamp `json:"last_changed_time,omitempty"` // Placeholder for description of property last_scale_status of obj type VipRuntime field type str type object LastScaleStatus *ScaleStatus `json:"last_scale_status,omitempty"` // Placeholder for description of property marked_for_delete of obj type VipRuntime field type str type boolean MarkedForDelete *bool `json:"marked_for_delete,omitempty"` // Enum options - METRICS_MGR_PORT_0, METRICS_MGR_PORT_1, METRICS_MGR_PORT_2, METRICS_MGR_PORT_3. MetricsMgrPort *string `json:"metrics_mgr_port,omitempty"` // Placeholder for description of property migrate_in_progress of obj type VipRuntime field type str type boolean MigrateInProgress *bool `json:"migrate_in_progress,omitempty"` // Placeholder for description of property migrate_request of obj type VipRuntime field type str type object MigrateRequest *VsMigrateParams `json:"migrate_request,omitempty"` // Placeholder for description of property migrate_scalein_pending of obj type VipRuntime field type str type boolean MigrateScaleinPending *bool `json:"migrate_scalein_pending,omitempty"` // Placeholder for description of property migrate_scaleout_pending of obj type VipRuntime field type str type boolean MigrateScaleoutPending *bool `json:"migrate_scaleout_pending,omitempty"` // Number of num_additional_se. NumAdditionalSe *int32 `json:"num_additional_se,omitempty"` // Enum options - METRICS_MGR_PORT_0, METRICS_MGR_PORT_1, METRICS_MGR_PORT_2, METRICS_MGR_PORT_3. PrevMetricsMgrPort *string `json:"prev_metrics_mgr_port,omitempty"` // Number of progress_percent. ProgressPercent *int32 `json:"progress_percent,omitempty"` // Placeholder for description of property requested_resource of obj type VipRuntime field type str type object RequestedResource *VirtualServiceResource `json:"requested_resource,omitempty"` // Placeholder for description of property scale_status of obj type VipRuntime field type str type object ScaleStatus *ScaleStatus `json:"scale_status,omitempty"` // Placeholder for description of property scalein_in_progress of obj type VipRuntime field type str type boolean ScaleinInProgress *bool `json:"scalein_in_progress,omitempty"` // Placeholder for description of property scalein_request of obj type VipRuntime field type str type object ScaleinRequest *VsScaleinParams `json:"scalein_request,omitempty"` // Placeholder for description of property scaleout_in_progress of obj type VipRuntime field type str type boolean ScaleoutInProgress *bool `json:"scaleout_in_progress,omitempty"` // Placeholder for description of property se_list of obj type VipRuntime field type str type object SeList []*SeList `json:"se_list,omitempty"` // Field deprecated in 18.2.5. ServersConfigured *bool `json:"servers_configured,omitempty"` // Placeholder for description of property supp_runtime_status of obj type VipRuntime field type str type object SuppRuntimeStatus *OperationalStatus `json:"supp_runtime_status,omitempty"` // Placeholder for description of property user_scaleout_pending of obj type VipRuntime field type str type boolean UserScaleoutPending *bool `json:"user_scaleout_pending,omitempty"` // vip_id of VipRuntime. VipID *string `json:"vip_id,omitempty"` // VIP finished resyncing with resource manager. Field introduced in 18.1.4, 18.2.1. WarmstartResyncDone *bool `json:"warmstart_resync_done,omitempty"` // RPC sent to resource manager for warmstart resync. Field introduced in 18.1.4, 18.2.1. WarmstartResyncSent *bool `json:"warmstart_resync_sent,omitempty"` }
VipRuntime vip runtime swagger:model VipRuntime
type VipScaleDetails ¶
type VipScaleDetails struct { // availability_zone of VipScaleDetails. AvailabilityZone *string `json:"availability_zone,omitempty"` // error of VipScaleDetails. Error *string `json:"error,omitempty"` // Unique object identifier of subnet. SubnetUUID *string `json:"subnet_uuid,omitempty"` // vip_id of VipScaleDetails. VipID *string `json:"vip_id,omitempty"` // Unique object identifier of vsvip. VsvipUUID *string `json:"vsvip_uuid,omitempty"` }
VipScaleDetails vip scale details swagger:model VipScaleDetails
type VipSeAssigned ¶
type VipSeAssigned struct { // Placeholder for description of property admin_down_requested of obj type VipSeAssigned field type str type boolean AdminDownRequested *bool `json:"admin_down_requested,omitempty"` // Placeholder for description of property connected of obj type VipSeAssigned field type str type boolean Connected *bool `json:"connected,omitempty"` // Management IPv4 address of SE. Field introduced in 20.1.3. MgmtIP *IPAddr `json:"mgmt_ip,omitempty"` // Management IPv6 address of SE. Field introduced in 20.1.3. MgmtIp6 *IPAddr `json:"mgmt_ip6,omitempty"` // Name of the object. Name *string `json:"name,omitempty"` // Placeholder for description of property oper_status of obj type VipSeAssigned field type str type object OperStatus *OperationalStatus `json:"oper_status,omitempty"` // Placeholder for description of property primary of obj type VipSeAssigned field type str type boolean Primary *bool `json:"primary,omitempty"` // It is a reference to an object of type ServiceEngine. Ref *string `json:"ref,omitempty"` // Placeholder for description of property scalein_in_progress of obj type VipSeAssigned field type str type boolean ScaleinInProgress *bool `json:"scalein_in_progress,omitempty"` // Placeholder for description of property snat_ip of obj type VipSeAssigned field type str type object SnatIP *IPAddr `json:"snat_ip,omitempty"` // Placeholder for description of property standby of obj type VipSeAssigned field type str type boolean Standby *bool `json:"standby,omitempty"` }
VipSeAssigned vip se assigned swagger:model VipSeAssigned
type VirtualService ¶
type VirtualService struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // This configuration only applies if the VirtualService is in Legacy Active Standby HA mode and Load Distribution among Active Standby is enabled. This field is used to tag the VirtualService so that VirtualServices with the same tag will share the same Active ServiceEngine. VirtualServices with different tags will have different Active ServiceEngines. If one of the ServiceEngine's in the ServiceEngineGroup fails, all VirtualServices will end up using the same Active ServiceEngine. Redistribution of the VirtualServices can be either manual or automated when the failed ServiceEngine recovers. Redistribution is based on the auto redistribute property of the ServiceEngineGroup. Enum options - ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2. ActiveStandbySeTag *string `json:"active_standby_se_tag,omitempty"` // Keep advertising Virtual Service via BGP even if it is marked down by health monitor. This setting takes effect for future Virtual Service flaps. To advertise current VSes that are down, please disable and re-enable the Virtual Service. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AdvertiseDownVs *bool `json:"advertise_down_vs,omitempty"` // Process request even if invalid client certificate is presented. Datascript APIs need to be used for processing of such requests. Field introduced in 18.2.3. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. AllowInvalidClientCert *bool `json:"allow_invalid_client_cert,omitempty"` // Determines analytics settings for the application. AnalyticsPolicy *AnalyticsPolicy `json:"analytics_policy,omitempty"` // Specifies settings related to analytics. It is a reference to an object of type AnalyticsProfile. AnalyticsProfileRef *string `json:"analytics_profile_ref,omitempty"` // The name of the Contract/Graph associated with the Virtual Service. Should be in the <Contract name> <Graph name> format. This is applicable only for Service Integration mode with Cisco APIC Controller . Field introduced in 17.2.12,18.1.2. Allowed in Basic edition, Essentials edition, Enterprise edition. ApicContractGraph *string `json:"apic_contract_graph,omitempty"` // Enable application layer specific features for the Virtual Service. It is a reference to an object of type ApplicationProfile. Special default for Essentials edition is System-L4-Application. ApplicationProfileRef *string `json:"application_profile_ref,omitempty"` // Auto-allocate floating/elastic IP from the Cloud infrastructure. Field deprecated in 17.1.1. AutoAllocateFloatingIP *bool `json:"auto_allocate_floating_ip,omitempty"` // Auto-allocate VIP from the provided subnet. Field deprecated in 17.1.1. AutoAllocateIP *bool `json:"auto_allocate_ip,omitempty"` // Availability-zone to place the Virtual Service. Field deprecated in 17.1.1. AvailabilityZone *string `json:"availability_zone,omitempty"` // (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field deprecated in 17.1.1. AviAllocatedFip *bool `json:"avi_allocated_fip,omitempty"` // (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field deprecated in 17.1.1. AviAllocatedVip *bool `json:"avi_allocated_vip,omitempty"` // (internal-use)Applicable for Azure only. Azure Availability set to which this VS is associated. Internally set by the cloud connector. Field introduced in 17.2.12, 18.1.2. // Read Only: true AzureAvailabilitySet *string `json:"azure_availability_set,omitempty"` // Bot detection policy for the Virtual Service. It is a reference to an object of type BotDetectionPolicy. Field introduced in 21.1.1. BotPolicyRef *string `json:"bot_policy_ref,omitempty"` // (This is a beta feature). Sync Key-Value cache to the new SEs when VS is scaled out. For ex SSL sessions are stored using VS's Key-Value cache. When the VS is scaled out, the SSL session information is synced to the new SE, allowing existing SSL sessions to be reused on the new SE. . Field introduced in 17.2.7, 18.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. BulkSyncKvcache *bool `json:"bulk_sync_kvcache,omitempty"` // HTTP authentication configuration for protected resources. ClientAuth *HTTPClientAuthenticationParams `json:"client_auth,omitempty"` // close client connection on vs config update. Field introduced in 17.2.4. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. CloseClientConnOnConfigUpdate *bool `json:"close_client_conn_on_config_update,omitempty"` // Checksum of cloud configuration for VS. Internally set by cloud connector. CloudConfigCksum *string `json:"cloud_config_cksum,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Allowed in Basic(Allowed values- CLOUD_NONE,CLOUD_NSXT) edition, Essentials(Allowed values- CLOUD_NONE,CLOUD_VCENTER) edition, Enterprise edition. CloudType *string `json:"cloud_type,omitempty"` // Rate limit the incoming connections to this virtual service. ConnectionsRateLimit *RateProfile `json:"connections_rate_limit,omitempty"` // Profile used to match and rewrite strings in request and/or response body. ContentRewrite *ContentRewriteProfile `json:"content_rewrite,omitempty"` // Creator name. CreatedBy *string `json:"created_by,omitempty"` // Select the algorithm for QoS fairness. This determines how multiple Virtual Services sharing the same Service Engines will prioritize traffic over a congested network. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. DelayFairness *bool `json:"delay_fairness,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // (internal-use) Discovered networks providing reachability for client facing Virtual Service IP. This field is deprecated. It is a reference to an object of type Network. Field deprecated in 17.1.1. DiscoveredNetworkRef []string `json:"discovered_network_ref,omitempty"` // (internal-use) Discovered networks providing reachability for client facing Virtual Service IP. This field is used internally by Avi, not editable by the user. Field deprecated in 17.1.1. DiscoveredNetworks []*DiscoveredNetwork `json:"discovered_networks,omitempty"` // (internal-use) Discovered subnets providing reachability for client facing Virtual Service IP. This field is deprecated. Field deprecated in 17.1.1. DiscoveredSubnet []*IPAddrPrefix `json:"discovered_subnet,omitempty"` // Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. Note that only one of fqdn and dns_info setting is allowed. Maximum of 1000 items allowed. DNSInfo []*DNSInfo `json:"dns_info,omitempty"` // DNS Policies applied on the dns traffic of the Virtual Service. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. DNSPolicies []*DNSPolicies `json:"dns_policies,omitempty"` // Force placement on all SE's in service group (Mesos mode only). Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EastWestPlacement *bool `json:"east_west_placement,omitempty"` // Response traffic to clients will be sent back to the source MAC address of the connection, rather than statically sent to a default gateway. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True. EnableAutogw *bool `json:"enable_autogw,omitempty"` // Enable Route Health Injection using the BGP Config in the vrf context. EnableRhi *bool `json:"enable_rhi,omitempty"` // Enable Route Health Injection for Source NAT'ted floating IP Address using the BGP Config in the vrf context. EnableRhiSnat *bool `json:"enable_rhi_snat,omitempty"` // Enable or disable the Virtual Service. Enabled *bool `json:"enabled,omitempty"` // Error Page Profile to be used for this virtualservice.This profile is used to send the custom error page to the client generated by the proxy. It is a reference to an object of type ErrorPageProfile. Field introduced in 17.2.4. Allowed in Basic edition, Essentials edition, Enterprise edition. ErrorPageProfileRef *string `json:"error_page_profile_ref,omitempty"` // Floating IP to associate with this Virtual Service. Field deprecated in 17.1.1. FloatingIP *IPAddr `json:"floating_ip,omitempty"` // If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. This field is applicable only if the VirtualService belongs to an OpenStack or AWS cloud. In OpenStack or AWS cloud it is required when auto_allocate_floating_ip is selected. Field deprecated in 17.1.1. FloatingSubnetUUID *string `json:"floating_subnet_uuid,omitempty"` // Criteria for flow distribution among SEs. Enum options - LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT. Allowed in Basic(Allowed values- LOAD_AWARE) edition, Essentials(Allowed values- LOAD_AWARE) edition, Enterprise edition. FlowDist *string `json:"flow_dist,omitempty"` // Criteria for flow labelling. Enum options - NO_LABEL, APPLICATION_LABEL, SERVICE_LABEL. FlowLabelType *string `json:"flow_label_type,omitempty"` // DNS resolvable, fully qualified domain name of the virtualservice. Only one of 'fqdn' and 'dns_info' configuration is allowed. Fqdn *string `json:"fqdn,omitempty"` // Translate the host name sent to the servers to this value. Translate the host name sent from servers back to the value used by the client. HostNameXlate *string `json:"host_name_xlate,omitempty"` // HTTP Policies applied on the data traffic of the Virtual Service. HTTPPolicies []*HTTPPolicies `json:"http_policies,omitempty"` // The config settings for the ICAP server when checking the HTTP request. It is a reference to an object of type IcapProfile. Field introduced in 20.1.1. Maximum of 1 items allowed. Allowed in Basic edition, Essentials edition, Enterprise edition. IcapRequestProfileRefs []string `json:"icap_request_profile_refs,omitempty"` // Ignore Pool servers network reachability constraints for Virtual Service placement. IgnPoolNetReach *bool `json:"ign_pool_net_reach,omitempty"` // IP Address of the Virtual Service. Field deprecated in 17.1.1. IPAddress *IPAddr `json:"ip_address,omitempty"` // Subnet and/or Network for allocating VirtualService IP by IPAM Provider module. Field deprecated in 17.1.1. IPAMNetworkSubnet *IPNetworkSubnet `json:"ipam_network_subnet,omitempty"` // Application-specific config for JWT validation. Field introduced in 20.1.3. JwtConfig *JWTValidationVsConfig `json:"jwt_config,omitempty"` // L4 Policies applied to the data traffic of the Virtual Service. Field introduced in 17.2.7. L4Policies []*L4Policies `json:"l4_policies,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Limit potential DoS attackers who exceed max_cps_per_client significantly to a fraction of max_cps_per_client for a while. LimitDoser *bool `json:"limit_doser,omitempty"` // Maximum connections per second per client IP. Allowed values are 10-1000. Special values are 0- 'unlimited'. MaxCpsPerClient *int32 `json:"max_cps_per_client,omitempty"` // Microservice representing the virtual service. It is a reference to an object of type MicroService. MicroserviceRef *string `json:"microservice_ref,omitempty"` // Minimum number of UP pools to mark VS up. Field introduced in 18.2.1, 17.2.12. MinPoolsUp *int32 `json:"min_pools_up,omitempty"` // Name for the Virtual Service. // Required: true Name *string `json:"name"` // Determines network settings such as protocol, TCP or UDP, and related options for the protocol. It is a reference to an object of type NetworkProfile. Special default for Essentials edition is System-TCP-Fast-Path. NetworkProfileRef *string `json:"network_profile_ref,omitempty"` // Manually override the network on which the Virtual Service is placed. It is a reference to an object of type Network. Field deprecated in 17.1.1. NetworkRef *string `json:"network_ref,omitempty"` // Network security policies for the Virtual Service. It is a reference to an object of type NetworkSecurityPolicy. NetworkSecurityPolicyRef *string `json:"network_security_policy_ref,omitempty"` // A list of NSX Groups representing the Clients which can access the Virtual IP of the Virtual Service. Field introduced in 17.1.1. NsxSecuritygroup []string `json:"nsx_securitygroup,omitempty"` // Optional settings that determine performance limits like max connections or bandwdith etc. PerformanceLimits *PerformanceLimits `json:"performance_limits,omitempty"` // The pool group is an object that contains pools. It is a reference to an object of type PoolGroup. PoolGroupRef *string `json:"pool_group_ref,omitempty"` // The pool is an object that contains destination servers and related attributes such as load-balancing and persistence. It is a reference to an object of type Pool. PoolRef *string `json:"pool_ref,omitempty"` // (internal-use) Network port assigned to the Virtual Service IP address. Field deprecated in 17.1.1. PortUUID *string `json:"port_uuid,omitempty"` // Remove listening port if VirtualService is down. RemoveListeningPortOnVsDown *bool `json:"remove_listening_port_on_vs_down,omitempty"` // Rate limit the incoming requests to this virtual service. RequestsRateLimit *RateProfile `json:"requests_rate_limit,omitempty"` // Application-specific SAML config. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. SamlSpConfig *SAMLSPConfig `json:"saml_sp_config,omitempty"` // Disable re-distribution of flows across service engines for a virtual service. Enable if the network itself performs flow hashing with ECMP in environments such as GCP. ScaleoutEcmp *bool `json:"scaleout_ecmp,omitempty"` // The Service Engine Group to use for this Virtual Service. Moving to a new SE Group is disruptive to existing connections for this VS. It is a reference to an object of type ServiceEngineGroup. SeGroupRef *string `json:"se_group_ref,omitempty"` // Security policy applied on the traffic of the Virtual Service. This policy is used to perform security actions such as Distributed Denial of Service (DDoS) attack mitigation, etc. It is a reference to an object of type SecurityPolicy. Field introduced in 18.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. SecurityPolicyRef *string `json:"security_policy_ref,omitempty"` // Determines the network settings profile for the server side of TCP proxied connections. Leave blank to use the same settings as the client to VS side of the connection. It is a reference to an object of type NetworkProfile. ServerNetworkProfileRef *string `json:"server_network_profile_ref,omitempty"` // Metadata pertaining to the Service provided by this virtual service. In Openshift/Kubernetes environments, egress pod info is stored. Any user input to this field will be overwritten by Avi Vantage. ServiceMetadata *string `json:"service_metadata,omitempty"` // Select pool based on destination port. ServicePoolSelect []*ServicePoolSelector `json:"service_pool_select,omitempty"` // List of Services defined for this Virtual Service. Maximum of 2048 items allowed. Services []*Service `json:"services,omitempty"` // Sideband configuration to be used for this virtualservice.It can be used for sending traffic to sideband VIPs for external inspection etc. SidebandProfile *SidebandProfile `json:"sideband_profile,omitempty"` // NAT'ted floating source IP Address(es) for upstream connection to servers. Maximum of 32 items allowed. SnatIP []*IPAddr `json:"snat_ip,omitempty"` // GSLB pools used to manage site-persistence functionality. Each site-persistence pool contains the virtualservices in all the other sites, that is auto-generated by the GSLB manager. This is a read-only field for the user. It is a reference to an object of type Pool. Field introduced in 17.2.2. // Read Only: true SpPoolRefs []string `json:"sp_pool_refs,omitempty"` // Select or create one or two certificates, EC and/or RSA, that will be presented to SSL/TLS terminated connections. It is a reference to an object of type SSLKeyAndCertificate. SslKeyAndCertificateRefs []string `json:"ssl_key_and_certificate_refs,omitempty"` // Determines the set of SSL versions and ciphers to accept for SSL/TLS terminated connections. It is a reference to an object of type SSLProfile. SslProfileRef *string `json:"ssl_profile_ref,omitempty"` // Select SSL Profile based on client IP address match. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. SslProfileSelectors []*SSLProfileSelector `json:"ssl_profile_selectors,omitempty"` // Expected number of SSL session cache entries (may be exceeded). Allowed values are 1024-16383. SslSessCacheAvgSize *int32 `json:"ssl_sess_cache_avg_size,omitempty"` // Client Authentication and Authorization Policy for the virtualservice. Field deprecated in 18.2.3. Field introduced in 18.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. SsoPolicy *SSOPolicy `json:"sso_policy,omitempty"` // The SSO Policy attached to the virtualservice. It is a reference to an object of type SSOPolicy. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. SsoPolicyRef *string `json:"sso_policy_ref,omitempty"` // List of static DNS records applied to this Virtual Service. These are static entries and no health monitoring is performed against the IP addresses. Maximum of 1000 items allowed. StaticDNSRecords []*DNSRecord `json:"static_dns_records,omitempty"` // Subnet providing reachability for client facing Virtual Service IP. Field deprecated in 17.1.1. Subnet *IPAddrPrefix `json:"subnet,omitempty"` // It represents subnet for the Virtual Service IP address allocation when auto_allocate_ip is True.It is only applicable in OpenStack or AWS cloud. This field is required if auto_allocate_ip is True. Field deprecated in 17.1.1. SubnetUUID *string `json:"subnet_uuid,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Used for testing SE Datastore Upgrade 2.0 functionality. It is a reference to an object of type TestSeDatastoreLevel1. Field introduced in 18.2.6. TestSeDatastoreLevel1Ref *string `json:"test_se_datastore_level_1_ref,omitempty"` // Topology Policies applied on the dns traffic of the Virtual Service based onGSLB Topology algorithm. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. TopologyPolicies []*DNSPolicies `json:"topology_policies,omitempty"` // Server network or list of servers for cloning traffic. It is a reference to an object of type TrafficCloneProfile. Field introduced in 17.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. TrafficCloneProfileRef *string `json:"traffic_clone_profile_ref,omitempty"` // Knob to enable the Virtual Service traffic on its assigned service engines. This setting is effective only when the enabled flag is set to True. Field introduced in 17.2.8. TrafficEnabled *bool `json:"traffic_enabled,omitempty"` // Specify if this is a normal Virtual Service, or if it is the parent or child of an SNI-enabled virtual hosted Virtual Service. Enum options - VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD. Allowed in Basic(Allowed values- VS_TYPE_NORMAL,VS_TYPE_VH_PARENT) edition, Essentials(Allowed values- VS_TYPE_NORMAL) edition, Enterprise edition. Type *string `json:"type,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Use Bridge IP as VIP on each Host in Mesos deployments. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. UseBridgeIPAsVip *bool `json:"use_bridge_ip_as_vip,omitempty"` // Use the Virtual IP as the SNAT IP for health monitoring and sending traffic to the backend servers instead of the Service Engine interface IP. The caveat of enabling this option is that the VirtualService cannot be configued in an Active-Active HA mode. DNS based Multi VIP solution has to be used for HA & Non-disruptive Upgrade purposes. Field introduced in 17.1.9,17.2.3. Allowed in Essentials(Allowed values- false) edition, Enterprise edition. UseVipAsSnat *bool `json:"use_vip_as_snat,omitempty"` // UUID of the VirtualService. UUID *string `json:"uuid,omitempty"` // The exact name requested from the client's SNI-enabled TLS hello domain name field. If this is a match, the parent VS will forward the connection to this child VS. VhDomainName []string `json:"vh_domain_name,omitempty"` // Host and path match criteria to select this child VS. Field introduced in 20.1.3. VhMatches []*VHMatch `json:"vh_matches,omitempty"` // Specifies the Virtual Service acting as Virtual Hosting (SNI) parent. VhParentVsUUID *string `json:"vh_parent_vs_uuid,omitempty"` // Specify if the Virtual Hosting VS is of type SNI or Enhanced. Enum options - VS_TYPE_VH_SNI, VS_TYPE_VH_ENHANCED. Field introduced in 20.1.3. Allowed in Basic(Allowed values- VS_TYPE_VH_ENHANCED) edition, Enterprise edition. Special default for Basic edition is VS_TYPE_VH_ENHANCED, Enterprise is VS_TYPE_VH_SNI. VhType *string `json:"vh_type,omitempty"` // List of Virtual Service IPs. While creating a 'Shared VS',please use vsvip_ref to point to the shared entities. Field introduced in 17.1.1. Vip []*Vip `json:"vip,omitempty"` // Virtual Routing Context that the Virtual Service is bound to. This is used to provide the isolation of the set of networks the application is attached to. It is a reference to an object of type VrfContext. VrfContextRef *string `json:"vrf_context_ref,omitempty"` // Datascripts applied on the data traffic of the Virtual Service. VsDatascripts []*VSDataScripts `json:"vs_datascripts,omitempty"` // Checksum of cloud configuration for VsVip. Internally set by cloud connector. Field introduced in 17.2.9, 18.1.2. VsvipCloudConfigCksum *string `json:"vsvip_cloud_config_cksum,omitempty"` // Mostly used during the creation of Shared VS, this field refers to entities that can be shared across Virtual Services. It is a reference to an object of type VsVip. Field introduced in 17.1.1. VsvipRef *string `json:"vsvip_ref,omitempty"` // WAF policy for the Virtual Service. It is a reference to an object of type WafPolicy. Field introduced in 17.2.1. Allowed in Basic edition, Essentials edition, Enterprise edition. WafPolicyRef *string `json:"waf_policy_ref,omitempty"` // The Quality of Service weight to assign to traffic transmitted from this Virtual Service. A higher weight will prioritize traffic versus other Virtual Services sharing the same Service Engines. Allowed values are 1-128. Allowed in Basic(Allowed values- 1) edition, Essentials(Allowed values- 1) edition, Enterprise edition. Weight *int32 `json:"weight,omitempty"` }
VirtualService virtual service swagger:model VirtualService
type VirtualServiceAPIResponse ¶
type VirtualServiceAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VirtualService `json:"results,omitempty"` }
VirtualServiceAPIResponse virtual service Api response swagger:model VirtualServiceApiResponse
type VirtualServiceResource ¶
type VirtualServiceResource struct { // This field is not being used. Field deprecated in 18.1.5, 18.2.1. IsExclusive *bool `json:"is_exclusive,omitempty"` // Number of memory. Memory *int32 `json:"memory,omitempty"` // Number of num_se. NumSe *int32 `json:"num_se,omitempty"` // Number of num_standby_se. NumStandbySe *int32 `json:"num_standby_se,omitempty"` // Number of num_vcpus. NumVcpus *int32 `json:"num_vcpus,omitempty"` // Indicates if the primary SE is being scaled in. This state is now derived from the Virtual Service runtime. Field deprecated in 18.1.5, 18.2.1. ScaleinPrimary *bool `json:"scalein_primary,omitempty"` // Indicates which SE is being scaled in. This information is now derived from the Virtual Service runtime. Field deprecated in 18.1.5, 18.2.1. ScaleinSeUUID *string `json:"scalein_se_uuid,omitempty"` }
VirtualServiceResource virtual service resource swagger:model VirtualServiceResource
type VirtualServiceRuntime ¶
type VirtualServiceRuntime struct { // Placeholder for description of property apic_extension of obj type VirtualServiceRuntime field type str type object ApicExtension *VsApicExtension `json:"apic_extension,omitempty"` // controller_ip of VirtualServiceRuntime. ControllerIP *string `json:"controller_ip,omitempty"` // Placeholder for description of property datapath_debug of obj type VirtualServiceRuntime field type str type object DatapathDebug *DebugVirtualService `json:"datapath_debug,omitempty"` // Placeholder for description of property east_west of obj type VirtualServiceRuntime field type str type boolean EastWest *bool `json:"east_west,omitempty"` // Deprecated, handled by SE Datastore. Field deprecated in 18.1.5, 18.2.1. Field introduced in 17.1.1. GslbDNSGeoUpdate *GslbDNSGeoUpdate `json:"gslb_dns_geo_update,omitempty"` // Placeholder for description of property gslb_dns_update of obj type VirtualServiceRuntime field type str type object GslbDNSUpdate *GslbDNSUpdate `json:"gslb_dns_update,omitempty"` // Placeholder for description of property ipam_dns_records of obj type VirtualServiceRuntime field type str type object IPAMDNSRecords []*DNSRecord `json:"ipam_dns_records,omitempty"` // Placeholder for description of property is_dns_vs of obj type VirtualServiceRuntime field type str type boolean IsDNSVs *bool `json:"is_dns_vs,omitempty"` // Number of times keys have been rotated. Field introduced in 18.2.2. KeyRotationCount *int64 `json:"key_rotation_count,omitempty"` // Placeholder for description of property last_changed_time of obj type VirtualServiceRuntime field type str type object LastChangedTime *TimeStamp `json:"last_changed_time,omitempty"` // Timestamp of the last key rotation. Field introduced in 18.2.2. LastKeyRotationTime *TimeStamp `json:"last_key_rotation_time,omitempty"` // lif of VirtualServiceRuntime. Lif []string `json:"lif,omitempty"` // Placeholder for description of property manual_placement of obj type VirtualServiceRuntime field type str type boolean ManualPlacement *bool `json:"manual_placement,omitempty"` // Placeholder for description of property marked_for_delete of obj type VirtualServiceRuntime field type str type boolean MarkedForDelete *bool `json:"marked_for_delete,omitempty"` // Enum options - METRICS_MGR_PORT_0, METRICS_MGR_PORT_1, METRICS_MGR_PORT_2, METRICS_MGR_PORT_3. MetricsMgrPort *string `json:"metrics_mgr_port,omitempty"` // Number of num_additional_se. NumAdditionalSe *int32 `json:"num_additional_se,omitempty"` // Placeholder for description of property one_plus_one_ha of obj type VirtualServiceRuntime field type str type boolean OnePlusOneHa *bool `json:"one_plus_one_ha,omitempty"` // prev_controller_ip of VirtualServiceRuntime. PrevControllerIP *string `json:"prev_controller_ip,omitempty"` // Enum options - METRICS_MGR_PORT_0, METRICS_MGR_PORT_1, METRICS_MGR_PORT_2, METRICS_MGR_PORT_3. PrevMetricsMgrPort *string `json:"prev_metrics_mgr_port,omitempty"` // Number of redis_db. RedisDb *int32 `json:"redis_db,omitempty"` // Field deprecated in 18.1.5, 18.2.1. RedisIP *string `json:"redis_ip,omitempty"` // Number of redis_port. RedisPort *int32 `json:"redis_port,omitempty"` // Field deprecated in 18.2.5. RulesConfigured *bool `json:"rules_configured,omitempty"` // Runtime info from security_manager. Field introduced in 18.2.5. SecMgrInfo *SecurityMgrRuntime `json:"sec_mgr_info,omitempty"` // Enable Service Engines to elect a primary amongst themselves in the absence of connectivity to controller. Field introduced in 18.1.2. SelfSeElection *bool `json:"self_se_election,omitempty"` // Field deprecated in 18.2.5. ServersConfigured *bool `json:"servers_configured,omitempty"` // Placeholder for description of property tls_ticket_key of obj type VirtualServiceRuntime field type str type object TLSTicketKey []*TLSTicket `json:"tls_ticket_key,omitempty"` // Enum options - VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD. Type *string `json:"type,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Version number of the SE List update. Version *int64 `json:"version,omitempty"` // It is a reference to an object of type VirtualService. VhChildVsRef []string `json:"vh_child_vs_ref,omitempty"` // Placeholder for description of property vip_runtime of obj type VirtualServiceRuntime field type str type object VipRuntime []*VipRuntime `json:"vip_runtime,omitempty"` // VS update request received before warmstart finished. Field introduced in 18.1.4, 18.2.1. VsUpdatePending *VirtualService `json:"vs_update_pending,omitempty"` }
VirtualServiceRuntime virtual service runtime swagger:model VirtualServiceRuntime
type VlanInterface ¶
type VlanInterface struct { // Placeholder for description of property dhcp_enabled of obj type VlanInterface field type str type boolean DhcpEnabled *bool `json:"dhcp_enabled,omitempty"` // Enable the interface. Field introduced in 18.2.5. Enabled *bool `json:"enabled,omitempty"` // if_name of VlanInterface. // Required: true IfName *string `json:"if_name"` // Enable IPv6 auto configuration. Field introduced in 18.1.1. Ip6AutocfgEnabled *bool `json:"ip6_autocfg_enabled,omitempty"` // Placeholder for description of property is_mgmt of obj type VlanInterface field type str type boolean IsMgmt *bool `json:"is_mgmt,omitempty"` // VLAN ID. Allowed values are 0-4096. VlanID *int32 `json:"vlan_id,omitempty"` // Placeholder for description of property vnic_networks of obj type VlanInterface field type str type object VnicNetworks []*VNICNetwork `json:"vnic_networks,omitempty"` // It is a reference to an object of type VrfContext. VrfRef *string `json:"vrf_ref,omitempty"` }
VlanInterface vlan interface swagger:model VlanInterface
type VlanRange ¶
type VlanRange struct { // Number of end. // Required: true End *int32 `json:"end"` // Number of start. // Required: true Start *int32 `json:"start"` }
VlanRange vlan range swagger:model VlanRange
type VrfContext ¶
type VrfContext struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Key/value vrfcontext attributes. Field introduced in 20.1.2. Allowed in Basic edition, Essentials edition, Enterprise edition. Attrs []*KeyValue `json:"attrs,omitempty"` // BFD configuration profile. Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition. BfdProfile *BfdProfile `json:"bfd_profile,omitempty"` // Bgp Local and Peer Info. BgpProfile *BgpProfile `json:"bgp_profile,omitempty"` // It is a reference to an object of type Cloud. CloudRef *string `json:"cloud_ref,omitempty"` // Configure debug flags for VRF. Field introduced in 17.1.1. Debugvrfcontext *DebugVrfContext `json:"debugvrfcontext,omitempty"` // User defined description for the object. Description *string `json:"description,omitempty"` // Configure ping based heartbeat check for gateway in service engines of vrf. Maximum of 32 items allowed. GatewayMon []*GatewayMonitor `json:"gateway_mon,omitempty"` // Configure ping based heartbeat check for all default gateways in service engines of vrf. Field introduced in 17.1.1. InternalGatewayMonitor *InternalGatewayMonitor `json:"internal_gateway_monitor,omitempty"` // Key/value labels which can be used for Object Access Policy permission scoping. Field introduced in 18.2.7, 20.1.1. Labels []*KeyValue `json:"labels,omitempty"` // Enable LLDP. Field introduced in 18.2.10, 20.1.1. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. LldpEnable *bool `json:"lldp_enable,omitempty"` // Name of the object. // Required: true Name *string `json:"name"` // Placeholder for description of property static_routes of obj type VrfContext field type str type object StaticRoutes []*StaticRoute `json:"static_routes,omitempty"` // Placeholder for description of property system_default of obj type VrfContext field type str type boolean SystemDefault *bool `json:"system_default,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
VrfContext vrf context swagger:model VrfContext
type VrfContextAPIResponse ¶
type VrfContextAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VrfContext `json:"results,omitempty"` }
VrfContextAPIResponse vrf context Api response swagger:model VrfContextApiResponse
type VsApicExtension ¶
type VsApicExtension struct { // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` // Unique object identifier of txn. // Required: true TxnUUID *string `json:"txn_uuid"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Placeholder for description of property vnic of obj type VsApicExtension field type str type object Vnic []*VsSeVnic `json:"vnic,omitempty"` }
VsApicExtension vs apic extension swagger:model VsApicExtension
type VsAwaitingSeEventDetails ¶
type VsAwaitingSeEventDetails struct { // Number of awaitingse_timeout. // Required: true AwaitingseTimeout *int32 `json:"awaitingse_timeout"` // ip of VsAwaitingSeEventDetails. IP *string `json:"ip,omitempty"` // Placeholder for description of property se_assigned of obj type VsAwaitingSeEventDetails field type str type object SeAssigned []*VipSeAssigned `json:"se_assigned,omitempty"` // Placeholder for description of property se_requested of obj type VsAwaitingSeEventDetails field type str type object SeRequested *VirtualServiceResource `json:"se_requested,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
VsAwaitingSeEventDetails vs awaiting se event details swagger:model VsAwaitingSeEventDetails
type VsDebugFilter ¶
type VsDebugFilter struct { // Name of the object. Name *string `json:"name,omitempty"` // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` }
VsDebugFilter vs debug filter swagger:model VsDebugFilter
type VsError ¶
type VsError struct { // The time at which the error occurred. Field introduced in 18.2.10, 20.1.1. EventTimestamp *TimeStamp `json:"event_timestamp,omitempty"` // reason of VsError. Reason []string `json:"reason,omitempty"` // Enum options - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY. SeGroupHaMode *string `json:"se_group_ha_mode,omitempty"` // It is a reference to an object of type ServiceEngineGroup. SeGroupRef *string `json:"se_group_ref,omitempty"` // The SE on which the VS errored during scale-in/scale-out operations. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.10, 20.1.1. SeRef *string `json:"se_ref,omitempty"` // It is a reference to an object of type Tenant. TenantRef *string `json:"tenant_ref,omitempty"` // Enum options - TRAFFIC_DISRUPTED, TRAFFIC_NOT_DISRUPTED. TrafficStatus *string `json:"traffic_status,omitempty"` // vip_id of VsError. VipID *string `json:"vip_id,omitempty"` // It is a reference to an object of type VirtualService. VsRef *string `json:"vs_ref,omitempty"` }
VsError vs error swagger:model VsError
type VsErrorEventDetails ¶
type VsErrorEventDetails struct { // error_message of VsErrorEventDetails. ErrorMessage *string `json:"error_message,omitempty"` // ip of VsErrorEventDetails. IP *string `json:"ip,omitempty"` // ip6 of VsErrorEventDetails. Ip6 *string `json:"ip6,omitempty"` // Number of rpc_status. RPCStatus *int64 `json:"rpc_status,omitempty"` // Placeholder for description of property se_assigned of obj type VsErrorEventDetails field type str type object SeAssigned []*VipSeAssigned `json:"se_assigned,omitempty"` // Placeholder for description of property se_requested of obj type VsErrorEventDetails field type str type object SeRequested *VirtualServiceResource `json:"se_requested,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
VsErrorEventDetails vs error event details swagger:model VsErrorEventDetails
type VsEvStatus ¶
type VsEvStatus struct { // notes of VsEvStatus. Notes []string `json:"notes,omitempty"` // request of VsEvStatus. Request *string `json:"request,omitempty"` // result of VsEvStatus. Result *string `json:"result,omitempty"` }
VsEvStatus vs ev status swagger:model VsEvStatus
type VsFsmEventDetails ¶
type VsFsmEventDetails struct { // vip_id of VsFsmEventDetails. VipID *string `json:"vip_id,omitempty"` // Placeholder for description of property vs_rt of obj type VsFsmEventDetails field type str type object VsRt *VirtualServiceRuntime `json:"vs_rt,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
VsFsmEventDetails vs fsm event details swagger:model VsFsmEventDetails
type VsInitialPlacementEventDetails ¶
type VsInitialPlacementEventDetails struct { // error_message of VsInitialPlacementEventDetails. ErrorMessage *string `json:"error_message,omitempty"` // ip of VsInitialPlacementEventDetails. IP *string `json:"ip,omitempty"` // Number of rpc_status. RPCStatus *int64 `json:"rpc_status,omitempty"` // Placeholder for description of property se_assigned of obj type VsInitialPlacementEventDetails field type str type object SeAssigned []*VipSeAssigned `json:"se_assigned,omitempty"` // Placeholder for description of property se_requested of obj type VsInitialPlacementEventDetails field type str type object SeRequested *VirtualServiceResource `json:"se_requested,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
VsInitialPlacementEventDetails vs initial placement event details swagger:model VsInitialPlacementEventDetails
type VsMigrateEventDetails ¶
type VsMigrateEventDetails struct { // error_message of VsMigrateEventDetails. ErrorMessage *string `json:"error_message,omitempty"` // ip of VsMigrateEventDetails. IP *string `json:"ip,omitempty"` // ip6 of VsMigrateEventDetails. Ip6 *string `json:"ip6,omitempty"` // Number of rpc_status. RPCStatus *int64 `json:"rpc_status,omitempty"` // Placeholder for description of property scale_status of obj type VsMigrateEventDetails field type str type object ScaleStatus *ScaleStatus `json:"scale_status,omitempty"` // Placeholder for description of property se_assigned of obj type VsMigrateEventDetails field type str type object SeAssigned []*VipSeAssigned `json:"se_assigned,omitempty"` // Placeholder for description of property se_requested of obj type VsMigrateEventDetails field type str type object SeRequested *VirtualServiceResource `json:"se_requested,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
VsMigrateEventDetails vs migrate event details swagger:model VsMigrateEventDetails
type VsMigrateParams ¶
type VsMigrateParams struct { // It is a reference to an object of type ServiceEngine. FromSeRef *string `json:"from_se_ref,omitempty"` // Number of new_vcpus. NewVcpus *int32 `json:"new_vcpus,omitempty"` // It is a reference to an object of type VIMgrHostRuntime. ToHostRef *string `json:"to_host_ref,omitempty"` // Placeholder for description of property to_new_se of obj type VsMigrateParams field type str type boolean ToNewSe *bool `json:"to_new_se,omitempty"` // It is a reference to an object of type ServiceEngine. ToSeRef *string `json:"to_se_ref,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Field introduced in 17.1.1. // Required: true VipID *string `json:"vip_id"` }
VsMigrateParams vs migrate params swagger:model VsMigrateParams
type VsPoolNwFilterEventDetails ¶
type VsPoolNwFilterEventDetails struct { // filter of VsPoolNwFilterEventDetails. // Required: true Filter *string `json:"filter"` // Name of the object. // Required: true Name *string `json:"name"` // network of VsPoolNwFilterEventDetails. // Required: true Network *string `json:"network"` }
VsPoolNwFilterEventDetails vs pool nw filter event details swagger:model VsPoolNwFilterEventDetails
type VsResyncParams ¶
type VsResyncParams struct { // It is a reference to an object of type ServiceEngine. SeRef []string `json:"se_ref,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` }
VsResyncParams vs resync params swagger:model VsResyncParams
type VsScaleInEventDetails ¶
type VsScaleInEventDetails struct { // error_message of VsScaleInEventDetails. ErrorMessage *string `json:"error_message,omitempty"` // ip of VsScaleInEventDetails. IP *string `json:"ip,omitempty"` // ip6 of VsScaleInEventDetails. Ip6 *string `json:"ip6,omitempty"` // Number of rpc_status. RPCStatus *int64 `json:"rpc_status,omitempty"` // Placeholder for description of property scale_status of obj type VsScaleInEventDetails field type str type object ScaleStatus *ScaleStatus `json:"scale_status,omitempty"` // Placeholder for description of property se_assigned of obj type VsScaleInEventDetails field type str type object SeAssigned []*VipSeAssigned `json:"se_assigned,omitempty"` // Placeholder for description of property se_requested of obj type VsScaleInEventDetails field type str type object SeRequested *VirtualServiceResource `json:"se_requested,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
VsScaleInEventDetails vs scale in event details swagger:model VsScaleInEventDetails
type VsScaleOutEventDetails ¶
type VsScaleOutEventDetails struct { // error_message of VsScaleOutEventDetails. ErrorMessage *string `json:"error_message,omitempty"` // ip of VsScaleOutEventDetails. IP *string `json:"ip,omitempty"` // ip6 of VsScaleOutEventDetails. Ip6 *string `json:"ip6,omitempty"` // Number of rpc_status. RPCStatus *int64 `json:"rpc_status,omitempty"` // Placeholder for description of property scale_status of obj type VsScaleOutEventDetails field type str type object ScaleStatus *ScaleStatus `json:"scale_status,omitempty"` // Placeholder for description of property se_assigned of obj type VsScaleOutEventDetails field type str type object SeAssigned []*VipSeAssigned `json:"se_assigned,omitempty"` // Placeholder for description of property se_requested of obj type VsScaleOutEventDetails field type str type object SeRequested *VirtualServiceResource `json:"se_requested,omitempty"` // Unique object identifier of vs. // Required: true VsUUID *string `json:"vs_uuid"` }
VsScaleOutEventDetails vs scale out event details swagger:model VsScaleOutEventDetails
type VsScaleinParams ¶
type VsScaleinParams struct { // Placeholder for description of property admin_down of obj type VsScaleinParams field type str type boolean AdminDown *bool `json:"admin_down,omitempty"` // It is a reference to an object of type ServiceEngine. FromSeRef *string `json:"from_se_ref,omitempty"` // Placeholder for description of property scalein_primary of obj type VsScaleinParams field type str type boolean ScaleinPrimary *bool `json:"scalein_primary,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Field introduced in 17.1.1. // Required: true VipID *string `json:"vip_id"` }
VsScaleinParams vs scalein params swagger:model VsScaleinParams
type VsScaleoutParams ¶
type VsScaleoutParams struct { // Placeholder for description of property admin_up of obj type VsScaleoutParams field type str type boolean AdminUp *bool `json:"admin_up,omitempty"` // Number of new_vcpus. NewVcpus *int32 `json:"new_vcpus,omitempty"` // It is a reference to an object of type VIMgrHostRuntime. ToHostRef *string `json:"to_host_ref,omitempty"` // Placeholder for description of property to_new_se of obj type VsScaleoutParams field type str type boolean ToNewSe *bool `json:"to_new_se,omitempty"` // It is a reference to an object of type ServiceEngine. ToSeRef *string `json:"to_se_ref,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Field introduced in 17.1.1. // Required: true VipID *string `json:"vip_id"` }
VsScaleoutParams vs scaleout params swagger:model VsScaleoutParams
type VsSeVnic ¶
type VsSeVnic struct { // lif of VsSeVnic. Lif *string `json:"lif,omitempty"` // mac of VsSeVnic. // Required: true Mac *string `json:"mac"` // Enum options - VNIC_TYPE_FE, VNIC_TYPE_BE. // Required: true Type *string `json:"type"` }
VsSeVnic vs se vnic swagger:model VsSeVnic
type VsSwitchoverParams ¶
type VsSwitchoverParams struct { // Unique object identifier of se. SeUUID *string `json:"se_uuid,omitempty"` // Unique object identifier of the object. UUID *string `json:"uuid,omitempty"` // Field introduced in 17.1.1. // Required: true VipID *string `json:"vip_id"` }
VsSwitchoverParams vs switchover params swagger:model VsSwitchoverParams
type VsVip ¶
type VsVip struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // It is a reference to an object of type Cloud. Field introduced in 17.1.1. CloudRef *string `json:"cloud_ref,omitempty"` // Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. Field introduced in 17.1.1. Maximum of 1000 items allowed. Allowed in Basic edition, Essentials edition, Enterprise edition. DNSInfo []*DNSInfo `json:"dns_info,omitempty"` // Force placement on all Service Engines in the Service Engine Group (Container clouds only). Field introduced in 17.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. EastWestPlacement *bool `json:"east_west_placement,omitempty"` // Determines the set of IPAM networks to use for this VsVip. Selector type must be SELECTOR_IPAM and only one label is supported. Field introduced in 20.1.3. IPAMSelector *Selector `json:"ipam_selector,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Name for the VsVip object. Field introduced in 17.1.1. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 17.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // This sets the placement scope of virtualservice to given tier1 logical router in Nsx-t. Field introduced in 20.1.1. Tier1Lr *string `json:"tier1_lr,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // This overrides the cloud level default and needs to match the SE Group value in which it will be used if the SE Group use_standard_alb value is set. This is only used when FIP is used for VS on Azure Cloud. Field introduced in 18.2.3. Allowed in Basic edition, Essentials edition, Enterprise edition. UseStandardAlb *bool `json:"use_standard_alb,omitempty"` // UUID of the VsVip object. Field introduced in 17.1.1. UUID *string `json:"uuid,omitempty"` // List of Virtual Service IPs and other shareable entities. Field introduced in 17.1.1. Vip []*Vip `json:"vip,omitempty"` // Virtual Routing Context that the Virtual Service is bound to. This is used to provide the isolation of the set of networks the application is attached to. It is a reference to an object of type VrfContext. Field introduced in 17.1.1. VrfContextRef *string `json:"vrf_context_ref,omitempty"` // Checksum of cloud configuration for VsVip. Internally set by cloud connector. Field introduced in 17.2.9, 18.1.2. VsvipCloudConfigCksum *string `json:"vsvip_cloud_config_cksum,omitempty"` }
VsVip vs vip swagger:model VsVip
type VsVipAPIResponse ¶
type VsVipAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*VsVip `json:"results,omitempty"` }
VsVipAPIResponse vs vip Api response swagger:model VsVipApiResponse
type VserverL4MetricsObj ¶
type VserverL4MetricsObj struct { // apdex measuring quality of network connections to servers. Apdexc *float64 `json:"apdexc,omitempty"` // apdex measuring network connection quality based on RTT. Apdexrtt *float64 `json:"apdexrtt,omitempty"` // Number of Application DDOS attacks occurring. AvgApplicationDosAttacks *float64 `json:"avg_application_dos_attacks,omitempty"` // Average transmit and receive network bandwidth between client and virtual service. AvgBandwidth *float64 `json:"avg_bandwidth,omitempty"` // Averaged rate bytes dropped per second. AvgBytesPolicyDrops *float64 `json:"avg_bytes_policy_drops,omitempty"` // Rate of total connections per second. AvgCompleteConns *float64 `json:"avg_complete_conns,omitempty"` // Rate of dropped connections per second. AvgConnectionsDropped *float64 `json:"avg_connections_dropped,omitempty"` // DoS attack Rate of HTTP App Errors. AvgDosAppError *float64 `json:"avg_dos_app_error,omitempty"` // Number DDOS attacks occurring. AvgDosAttacks *float64 `json:"avg_dos_attacks,omitempty"` // DoS attack Rate of Bad Rst Floods. AvgDosBadRstFlood *float64 `json:"avg_dos_bad_rst_flood,omitempty"` // Average transmit and receive network bandwidth between client and virtual service related to DDoS attack. AvgDosBandwidth *float64 `json:"avg_dos_bandwidth,omitempty"` // Number of connections considered as DoS. AvgDosConn *float64 `json:"avg_dos_conn,omitempty"` // DoS attack Connections dropped due to IP rate limit. AvgDosConnIPRlDrop *float64 `json:"avg_dos_conn_ip_rl_drop,omitempty"` // DoS attack Connections dropped due to VS rate limit. AvgDosConnRlDrop *float64 `json:"avg_dos_conn_rl_drop,omitempty"` // DoS attack Rate of Fake Sessions. AvgDosFakeSession *float64 `json:"avg_dos_fake_session,omitempty"` // DoS attack Rate of HTTP Aborts. AvgDosHTTPAbort *float64 `json:"avg_dos_http_abort,omitempty"` // DoS attack Rate of HTTP Errors. AvgDosHTTPError *float64 `json:"avg_dos_http_error,omitempty"` // DoS attack Rate of HTTP Timeouts. AvgDosHTTPTimeout *float64 `json:"avg_dos_http_timeout,omitempty"` // DoS attack Rate of Malformed Packet Floods. AvgDosMalformedFlood *float64 `json:"avg_dos_malformed_flood,omitempty"` // DoS attack Non SYN packet flood. AvgDosNonSynFlood *float64 `json:"avg_dos_non_syn_flood,omitempty"` // Number of request considered as DoS. AvgDosReq *float64 `json:"avg_dos_req,omitempty"` // DoS attack Requests dropped due to Cookie rate limit. AvgDosReqCookieRlDrop *float64 `json:"avg_dos_req_cookie_rl_drop,omitempty"` // DoS attack Requests dropped due to Custom rate limit. Field introduced in 17.2.13,18.1.3,18.2.1. AvgDosReqCustomRlDrop *float64 `json:"avg_dos_req_custom_rl_drop,omitempty"` // DoS attack Requests dropped due to Header rate limit. AvgDosReqHdrRlDrop *float64 `json:"avg_dos_req_hdr_rl_drop,omitempty"` // DoS attack Requests dropped due to IP rate limit. AvgDosReqIPRlDrop *float64 `json:"avg_dos_req_ip_rl_drop,omitempty"` // DoS attack Requests dropped due to IP rate limit for bad requests. AvgDosReqIPRlDropBad *float64 `json:"avg_dos_req_ip_rl_drop_bad,omitempty"` // DoS attack Requests dropped due to bad IP rate limit. AvgDosReqIPScanBadRlDrop *float64 `json:"avg_dos_req_ip_scan_bad_rl_drop,omitempty"` // DoS attack Requests dropped due to unknown IP rate limit. AvgDosReqIPScanUnknownRlDrop *float64 `json:"avg_dos_req_ip_scan_unknown_rl_drop,omitempty"` // DoS attack Requests dropped due to IP+URL rate limit. AvgDosReqIPURIRlDrop *float64 `json:"avg_dos_req_ip_uri_rl_drop,omitempty"` // DoS attack Requests dropped due to IP+URL rate limit for bad requests. AvgDosReqIPURIRlDropBad *float64 `json:"avg_dos_req_ip_uri_rl_drop_bad,omitempty"` // DoS attack Requests dropped due to VS rate limit. AvgDosReqRlDrop *float64 `json:"avg_dos_req_rl_drop,omitempty"` // DoS attack Requests dropped due to URL rate limit. AvgDosReqURIRlDrop *float64 `json:"avg_dos_req_uri_rl_drop,omitempty"` // DoS attack Requests dropped due to URL rate limit for bad requests. AvgDosReqURIRlDropBad *float64 `json:"avg_dos_req_uri_rl_drop_bad,omitempty"` // DoS attack Requests dropped due to bad URL rate limit. AvgDosReqURIScanBadRlDrop *float64 `json:"avg_dos_req_uri_scan_bad_rl_drop,omitempty"` // DoS attack Requests dropped due to unknown URL rate limit. AvgDosReqURIScanUnknownRlDrop *float64 `json:"avg_dos_req_uri_scan_unknown_rl_drop,omitempty"` // Average rate of bytes received per second related to DDoS attack. AvgDosRxBytes *float64 `json:"avg_dos_rx_bytes,omitempty"` // DoS attack Slow Uri. AvgDosSlowURI *float64 `json:"avg_dos_slow_uri,omitempty"` // DoS attack Rate of Small Window Stresses. AvgDosSmallWindowStress *float64 `json:"avg_dos_small_window_stress,omitempty"` // DoS attack Rate of HTTP SSL Errors. AvgDosSslError *float64 `json:"avg_dos_ssl_error,omitempty"` // DoS attack Rate of Syn Floods. AvgDosSynFlood *float64 `json:"avg_dos_syn_flood,omitempty"` // Total number of request used for L7 dos requests normalization. AvgDosTotalReq *float64 `json:"avg_dos_total_req,omitempty"` // Average rate of bytes transmitted per second related to DDoS attack. AvgDosTxBytes *float64 `json:"avg_dos_tx_bytes,omitempty"` // DoS attack Rate of Zero Window Stresses. AvgDosZeroWindowStress *float64 `json:"avg_dos_zero_window_stress,omitempty"` // Rate of total errored connections per second. AvgErroredConnections *float64 `json:"avg_errored_connections,omitempty"` // Average rate of SYN DDoS attacks on Virtual Service. AvgHalfOpenConns *float64 `json:"avg_half_open_conns,omitempty"` // Average L4 connection duration which does not include client RTT. AvgL4ClientLatency *float64 `json:"avg_l4_client_latency,omitempty"` // Rate of lossy connections per second. AvgLossyConnections *float64 `json:"avg_lossy_connections,omitempty"` // Averaged rate of lossy request per second. AvgLossyReq *float64 `json:"avg_lossy_req,omitempty"` // Number of Network DDOS attacks occurring. AvgNetworkDosAttacks *float64 `json:"avg_network_dos_attacks,omitempty"` // Averaged rate of new client connections per second. AvgNewEstablishedConns *float64 `json:"avg_new_established_conns,omitempty"` // Averaged rate of dropped packets per second due to policy. AvgPktsPolicyDrops *float64 `json:"avg_pkts_policy_drops,omitempty"` // Rate of total connections dropped due to VS policy per second. It includes drops due to rate limits, security policy drops, connection limits etc. AvgPolicyDrops *float64 `json:"avg_policy_drops,omitempty"` // Average rate of bytes received per second. AvgRxBytes *float64 `json:"avg_rx_bytes,omitempty"` // Average rate of received bytes dropped per second. AvgRxBytesDropped *float64 `json:"avg_rx_bytes_dropped,omitempty"` // Average rate of packets received per second. AvgRxPkts *float64 `json:"avg_rx_pkts,omitempty"` // Average rate of received packets dropped per second. AvgRxPktsDropped *float64 `json:"avg_rx_pkts_dropped,omitempty"` // Total syncs sent across all connections. AvgSyns *float64 `json:"avg_syns,omitempty"` // Averaged rate bytes dropped per second. AvgTotalConnections *float64 `json:"avg_total_connections,omitempty"` // Average network round trip time between client and virtual service. AvgTotalRtt *float64 `json:"avg_total_rtt,omitempty"` // Average rate of bytes transmitted per second. AvgTxBytes *float64 `json:"avg_tx_bytes,omitempty"` // Average rate of packets transmitted per second. AvgTxPkts *float64 `json:"avg_tx_pkts,omitempty"` // Max number of SEs. MaxNumActiveSe *float64 `json:"max_num_active_se,omitempty"` // Max number of open connections. MaxOpenConns *float64 `json:"max_open_conns,omitempty"` // Total number of received bytes. MaxRxBytesAbsolute *float64 `json:"max_rx_bytes_absolute,omitempty"` // Total number of received frames. MaxRxPktsAbsolute *float64 `json:"max_rx_pkts_absolute,omitempty"` // Total number of transmitted bytes. MaxTxBytesAbsolute *float64 `json:"max_tx_bytes_absolute,omitempty"` // Total number of transmitted frames. MaxTxPktsAbsolute *float64 `json:"max_tx_pkts_absolute,omitempty"` // node_obj_id of VserverL4MetricsObj. // Required: true NodeObjID *string `json:"node_obj_id"` // Fraction of L7 requests owing to DoS. PctApplicationDosAttacks *float64 `json:"pct_application_dos_attacks,omitempty"` // Percent of l4 connection dropped and lossy for virtual service. PctConnectionErrors *float64 `json:"pct_connection_errors,omitempty"` // Fraction of L4 connections owing to DoS. PctConnectionsDosAttacks *float64 `json:"pct_connections_dos_attacks,omitempty"` // DoS bandwidth percentage. PctDosBandwidth *float64 `json:"pct_dos_bandwidth,omitempty"` // Percentage of received bytes as part of a DoS attack. PctDosRxBytes *float64 `json:"pct_dos_rx_bytes,omitempty"` // Deprecated. PctNetworkDosAttacks *float64 `json:"pct_network_dos_attacks,omitempty"` // Fraction of packets owing to DoS. PctPktsDosAttacks *float64 `json:"pct_pkts_dos_attacks,omitempty"` // Fraction of L4 requests dropped owing to policy. PctPolicyDrops *float64 `json:"pct_policy_drops,omitempty"` // Total duration across all connections. SumConnDuration *float64 `json:"sum_conn_duration,omitempty"` // Total number of connection dropped due to vserver connection limit. SumConnectionDroppedUserLimit *float64 `json:"sum_connection_dropped_user_limit,omitempty"` // Total number of client network connections that were lossy or dropped. SumConnectionErrors *float64 `json:"sum_connection_errors,omitempty"` // Total connections dropped including failed. SumConnectionsDropped *float64 `json:"sum_connections_dropped,omitempty"` // Total duplicate ACK retransmits across all connections. SumDupAckRetransmits *float64 `json:"sum_dup_ack_retransmits,omitempty"` // Sum of end to end network RTT experienced by end clients. Higher value would increase response times experienced by clients. SumEndToEndRtt *float64 `json:"sum_end_to_end_rtt,omitempty"` // Total connections that have RTT values from 0 to RTT threshold. SumEndToEndRttBucket1 *float64 `json:"sum_end_to_end_rtt_bucket1,omitempty"` // Total connections that have RTT values RTT threshold and above. SumEndToEndRttBucket2 *float64 `json:"sum_end_to_end_rtt_bucket2,omitempty"` // Total number of finished connections. SumFinishedConns *float64 `json:"sum_finished_conns,omitempty"` // Total connections that were lossy due to high packet retransmissions. SumLossyConnections *float64 `json:"sum_lossy_connections,omitempty"` // Total requests that were lossy due to high packet retransmissions. SumLossyReq *float64 `json:"sum_lossy_req,omitempty"` // Total out of order packets across all connections. SumOutOfOrders *float64 `json:"sum_out_of_orders,omitempty"` // Total number of packets dropped due to vserver bandwidth limit. SumPacketDroppedUserBandwidthLimit *float64 `json:"sum_packet_dropped_user_bandwidth_limit,omitempty"` // Total number connections used for rtt. SumRttValidConnections *float64 `json:"sum_rtt_valid_connections,omitempty"` // Total SACK retransmits across all connections. SumSackRetransmits *float64 `json:"sum_sack_retransmits,omitempty"` // Total number of connections with server flow control condition. SumServerFlowControl *float64 `json:"sum_server_flow_control,omitempty"` // Total connection timeouts in the interval. SumTimeoutRetransmits *float64 `json:"sum_timeout_retransmits,omitempty"` // Total number of zero window size events across all connections. SumZeroWindowSizeEvents *float64 `json:"sum_zero_window_size_events,omitempty"` }
VserverL4MetricsObj vserver l4 metrics obj swagger:model VserverL4MetricsObj
type VserverL7MetricsObj ¶
type VserverL7MetricsObj struct { // Client Apdex measures quality of server response based on latency. Apdexr *float64 `json:"apdexr,omitempty"` // Average server/application response latency. AvgApplicationResponseTime *float64 `json:"avg_application_response_time,omitempty"` // Average time client was blocked as reported by client. AvgBlockingTime *float64 `json:"avg_blocking_time,omitempty"` // Average browser rendering latency. AvgBrowserRenderingTime *float64 `json:"avg_browser_rendering_time,omitempty"` // Average cache bytes. AvgCacheBytes *float64 `json:"avg_cache_bytes,omitempty"` // Average cache hit of requests. AvgCacheHits *float64 `json:"avg_cache_hits,omitempty"` // Average cacheable bytes. AvgCacheableBytes *float64 `json:"avg_cacheable_bytes,omitempty"` // Average cacheable hit of requests. AvgCacheableHits *float64 `json:"avg_cacheable_hits,omitempty"` // Average client data transfer time that represents latency of sending response to the client excluding the RTT time . Higher client data transfer time signifies lower bandwidth between client and Avi Service Engine. AvgClientDataTransferTime *float64 `json:"avg_client_data_transfer_time,omitempty"` // Average client Round Trip Time. AvgClientRtt *float64 `json:"avg_client_rtt,omitempty"` // Average client transaction latency computed by adding response latencies across all HTTP requests. AvgClientTxnLatency *float64 `json:"avg_client_txn_latency,omitempty"` // Rate of HTTP responses sent per second. AvgCompleteResponses *float64 `json:"avg_complete_responses,omitempty"` // Average client connection latency reported by client. AvgConnectionTime *float64 `json:"avg_connection_time,omitempty"` // Average domain lookup latency reported by client. AvgDNSLookupTime *float64 `json:"avg_dns_lookup_time,omitempty"` // Average Dom content Load Time reported by clients. AvgDomContentLoadTime *float64 `json:"avg_dom_content_load_time,omitempty"` // Rate of HTTP error responses sent per second. It does not include errors excluded in analytics profile. AvgErrorResponses *float64 `json:"avg_error_responses,omitempty"` // Rate of HTTP responses excluded as errors based on analytics profile. AvgErrorsExcluded *float64 `json:"avg_errors_excluded,omitempty"` // Avg number of HTTP requests that completed within frustrated latency. AvgFrustratedResponses *float64 `json:"avg_frustrated_responses,omitempty"` // Average size of HTTP headers per request. Field introduced in 17.2.12, 18.1.2. AvgHTTPHeadersBytes *float64 `json:"avg_http_headers_bytes,omitempty"` // Average number of HTTP headers per request. Field introduced in 17.2.12, 18.1.2. AvgHTTPHeadersCount *float64 `json:"avg_http_headers_count,omitempty"` // Average number of HTTP request parameters per request. Field introduced in 17.2.12, 18.1.2. AvgHTTPParamsCount *float64 `json:"avg_http_params_count,omitempty"` // Average Page Load time reported by clients. AvgPageDownloadTime *float64 `json:"avg_page_download_time,omitempty"` // Average Page Load Time reported by client. AvgPageLoadTime *float64 `json:"avg_page_load_time,omitempty"` // Average number of HTTP request parameters per request, taking into account only requests with parameters. Field introduced in 17.2.12, 18.1.3. AvgParamsPerReq *float64 `json:"avg_params_per_req,omitempty"` // Average size of HTTP POST request. Field introduced in 17.2.12, 18.1.2. AvgPostBytes *float64 `json:"avg_post_bytes,omitempty"` // Average post compression bytes. AvgPostCompressionBytes *float64 `json:"avg_post_compression_bytes,omitempty"` // Average pre compression bytes. AvgPreCompressionBytes *float64 `json:"avg_pre_compression_bytes,omitempty"` // Average redirect latency reported by client. AvgRedirectionTime *float64 `json:"avg_redirection_time,omitempty"` // Average requests per session measured for closed sessions. AvgReqsPerSession *float64 `json:"avg_reqs_per_session,omitempty"` // Rate of 1xx HTTP responses sent per second. AvgResp1xx *float64 `json:"avg_resp_1xx,omitempty"` // Rate of 2xx HTTP responses sent per second. AvgResp2xx *float64 `json:"avg_resp_2xx,omitempty"` // Rate of 3xx HTTP responses sent per second. AvgResp3xx *float64 `json:"avg_resp_3xx,omitempty"` // Rate of 4xx HTTP responses sent per second. AvgResp4xx *float64 `json:"avg_resp_4xx,omitempty"` // Rate of 4xx HTTP responses as errors sent by avi. It does not include any error codes excluded in the analytics profile and pool server errors. AvgResp4xxAviErrors *float64 `json:"avg_resp_4xx_avi_errors,omitempty"` // Rate of 5xx HTTP responses sent per second. AvgResp5xx *float64 `json:"avg_resp_5xx,omitempty"` // Rate of 5xx HTTP responses as errors sent by avi. It does not include any error codes excluded in the analytics profile and pool server errors. AvgResp5xxAviErrors *float64 `json:"avg_resp_5xx_avi_errors,omitempty"` // Total client data transfer time by client. AvgRumClientDataTransferTime *float64 `json:"avg_rum_client_data_transfer_time,omitempty"` // Avg number of HTTP requests that completed within satisfactory latency. AvgSatisfactoryResponses *float64 `json:"avg_satisfactory_responses,omitempty"` // Average server Round Trip Time. AvgServerRtt *float64 `json:"avg_server_rtt,omitempty"` // Average latency from receipt of request to start of response. AvgServiceTime *float64 `json:"avg_service_time,omitempty"` // Average SSL Sessions using DSA certificate. AvgSslAuthDsa *float64 `json:"avg_ssl_auth_dsa,omitempty"` // Average SSL Sessions using Elliptic Curve DSA (ECDSA) certificates. AvgSslAuthEcdsa *float64 `json:"avg_ssl_auth_ecdsa,omitempty"` // Average SSL Sessions using RSA certificate. AvgSslAuthRsa *float64 `json:"avg_ssl_auth_rsa,omitempty"` // Average SSL Sessions. AvgSslConnections *float64 `json:"avg_ssl_connections,omitempty"` // Average SSL Exchanges using EC Cerificates without PFS. AvgSslEcdsaNonPfs *float64 `json:"avg_ssl_ecdsa_non_pfs,omitempty"` // Average SSL Exchanges using EC Cerificates and PFS. AvgSslEcdsaPfs *float64 `json:"avg_ssl_ecdsa_pfs,omitempty"` // Average SSL errors due to clients, protocol errors,network errors and handshake timeouts. AvgSslErrors *float64 `json:"avg_ssl_errors,omitempty"` // Average SSL connections failed due to protocol , network or timeout reasons. AvgSslFailedConnections *float64 `json:"avg_ssl_failed_connections,omitempty"` // Average SSL handshakes failed due to network errors. AvgSslHandshakeNetworkErrors *float64 `json:"avg_ssl_handshake_network_errors,omitempty"` // Average SSL handshake failed due to clients or protocol errors. AvgSslHandshakeProtocolErrors *float64 `json:"avg_ssl_handshake_protocol_errors,omitempty"` // Average new successful SSL sessions. AvgSslHandshakesNew *float64 `json:"avg_ssl_handshakes_new,omitempty"` // Average SSL Exchanges using Non-PFS. AvgSslHandshakesNonPfs *float64 `json:"avg_ssl_handshakes_non_pfs,omitempty"` // Average SSL Exchanges using PFS. AvgSslHandshakesPfs *float64 `json:"avg_ssl_handshakes_pfs,omitempty"` // Average new successful resumed SSL sessions. AvgSslHandshakesReused *float64 `json:"avg_ssl_handshakes_reused,omitempty"` // Average SSL handshakes timed out. AvgSslHandshakesTimedout *float64 `json:"avg_ssl_handshakes_timedout,omitempty"` // Average SSL Exchanges using Diffie-Hellman. AvgSslKxDh *float64 `json:"avg_ssl_kx_dh,omitempty"` // Average SSL Exchanges using RSA. AvgSslKxEcdh *float64 `json:"avg_ssl_kx_ecdh,omitempty"` // Average SSL Exchanges using RSA. AvgSslKxRsa *float64 `json:"avg_ssl_kx_rsa,omitempty"` // Average SSL Exchanges using RSA Cerificates without PFS. AvgSslRsaNonPfs *float64 `json:"avg_ssl_rsa_non_pfs,omitempty"` // Average SSL Exchanges using RSA Cerificates and PFS. AvgSslRsaPfs *float64 `json:"avg_ssl_rsa_pfs,omitempty"` // Average SSL Sessions with version 3.0. AvgSslVerSsl30 *float64 `json:"avg_ssl_ver_ssl30,omitempty"` // Average SSL Sessions with TLS version 1.0. AvgSslVerTLS10 *float64 `json:"avg_ssl_ver_tls10,omitempty"` // Average SSL Sessions with TLS version 1.1. AvgSslVerTLS11 *float64 `json:"avg_ssl_ver_tls11,omitempty"` // Average SSL Sessions with TLS version 1.2. AvgSslVerTLS12 *float64 `json:"avg_ssl_ver_tls12,omitempty"` // Average SSL Sessions with TLS version 1.3. Field introduced in 18.2.6. AvgSslVerTLS13 *float64 `json:"avg_ssl_ver_tls13,omitempty"` // Avg number of HTTP requests that completed within tolerated latency. AvgToleratedResponses *float64 `json:"avg_tolerated_responses,omitempty"` // Average number of client HTTP2 requests received by the Virtual Service per second. Field introduced in 18.2.5. AvgTotalHttp2Requests *float64 `json:"avg_total_http2_requests,omitempty"` // Average rate of client HTTP requests received by the virtual service per second. AvgTotalRequests *float64 `json:"avg_total_requests,omitempty"` // Average length of HTTP URI per request. Field introduced in 17.2.12, 18.1.2. AvgURILength *float64 `json:"avg_uri_length,omitempty"` // Average number of transactions per second identified by WAF as attacks. Field introduced in 17.2.3. AvgWafAttacks *float64 `json:"avg_waf_attacks,omitempty"` // Average number of transactions per second bypassing WAF. Field introduced in 17.2.12, 18.1.2. AvgWafDisabled *float64 `json:"avg_waf_disabled,omitempty"` // Average number of transactions per second evaluated by WAF. Field introduced in 17.2.2. AvgWafEvaluated *float64 `json:"avg_waf_evaluated,omitempty"` // Average number of requests per second evaluated by WAF in Request Body Phase. Field introduced in 17.2.2. AvgWafEvaluatedRequestBodyPhase *float64 `json:"avg_waf_evaluated_request_body_phase,omitempty"` // Average number of requests per second evaluated by WAF in Request Header Phase. Field introduced in 17.2.2. AvgWafEvaluatedRequestHeaderPhase *float64 `json:"avg_waf_evaluated_request_header_phase,omitempty"` // Average number of responses per second evaluated by WAF in Response Body Phase. Field introduced in 17.2.2. AvgWafEvaluatedResponseBodyPhase *float64 `json:"avg_waf_evaluated_response_body_phase,omitempty"` // Average number of responsess per second evaluated by WAF in Response Header Phase. Field introduced in 17.2.2. AvgWafEvaluatedResponseHeaderPhase *float64 `json:"avg_waf_evaluated_response_header_phase,omitempty"` // Average number of transactions per second flagged by WAF. Field introduced in 17.2.2. AvgWafFlagged *float64 `json:"avg_waf_flagged,omitempty"` // Average number of requests per second flagged (but not rejected) by WAF in Request Body Phase. Field introduced in 17.2.2. AvgWafFlaggedRequestBodyPhase *float64 `json:"avg_waf_flagged_request_body_phase,omitempty"` // Average number of requests per second flagged (but not rejected) by WAF in Request Header Phase. Field introduced in 17.2.2. AvgWafFlaggedRequestHeaderPhase *float64 `json:"avg_waf_flagged_request_header_phase,omitempty"` // Average number of responses per second flagged (but not rejected) by WAF in Response Body Phase. Field introduced in 17.2.2. AvgWafFlaggedResponseBodyPhase *float64 `json:"avg_waf_flagged_response_body_phase,omitempty"` // Average number of responses per second flagged (but not rejected) by WAF in Response Header Phase. Field introduced in 17.2.2. AvgWafFlaggedResponseHeaderPhase *float64 `json:"avg_waf_flagged_response_header_phase,omitempty"` // Average waf latency seen due to WAF Request Body processing. Field introduced in 17.2.2. AvgWafLatencyRequestBodyPhase *float64 `json:"avg_waf_latency_request_body_phase,omitempty"` // Average waf latency seen due to WAF Request Header processing. Field introduced in 17.2.2. AvgWafLatencyRequestHeaderPhase *float64 `json:"avg_waf_latency_request_header_phase,omitempty"` // Average waf latency seen due to WAF Response Body processing. Field introduced in 17.2.2. AvgWafLatencyResponseBodyPhase *float64 `json:"avg_waf_latency_response_body_phase,omitempty"` // Average waf latency seen due to WAF Response Header processing. Field introduced in 17.2.2. AvgWafLatencyResponseHeaderPhase *float64 `json:"avg_waf_latency_response_header_phase,omitempty"` // Average number of transactions per second matched by WAF rule/rules. Field introduced in 17.2.2. AvgWafMatched *float64 `json:"avg_waf_matched,omitempty"` // Average number of requests per second matched by WAF in Request Body Phase. Field introduced in 17.2.2. AvgWafMatchedRequestBodyPhase *float64 `json:"avg_waf_matched_request_body_phase,omitempty"` // Average number of requests per second matched by WAF in Request Header Phase. Field introduced in 17.2.2. AvgWafMatchedRequestHeaderPhase *float64 `json:"avg_waf_matched_request_header_phase,omitempty"` // Average number of responses per second matched by WAF in Response Body Phase. Field introduced in 17.2.2. AvgWafMatchedResponseBodyPhase *float64 `json:"avg_waf_matched_response_body_phase,omitempty"` // Average number of responses per second matched by WAF in Response Header Phase. Field introduced in 17.2.2. AvgWafMatchedResponseHeaderPhase *float64 `json:"avg_waf_matched_response_header_phase,omitempty"` // Average number of transactions per second rejected by WAF. Field introduced in 17.2.2. AvgWafRejected *float64 `json:"avg_waf_rejected,omitempty"` // Average number of requests per second rejected by WAF in Request Body Phase. Field introduced in 17.2.2. AvgWafRejectedRequestBodyPhase *float64 `json:"avg_waf_rejected_request_body_phase,omitempty"` // Average number of requests per second rejected by WAF in Request Header Phase. Field introduced in 17.2.2. AvgWafRejectedRequestHeaderPhase *float64 `json:"avg_waf_rejected_request_header_phase,omitempty"` // Average number of responses per second rejected by WAF in Response Body Phase. Field introduced in 17.2.2. AvgWafRejectedResponseBodyPhase *float64 `json:"avg_waf_rejected_response_body_phase,omitempty"` // Average number of responses per second rejected by WAF in Response Header Phase. Field introduced in 17.2.2. AvgWafRejectedResponseHeaderPhase *float64 `json:"avg_waf_rejected_response_header_phase,omitempty"` // Average Waiting Time reported by client. AvgWaitingTime *float64 `json:"avg_waiting_time,omitempty"` // Maximum number of concurrent HTTP sessions. MaxConcurrentSessions *float64 `json:"max_concurrent_sessions,omitempty"` // Maximum number of open SSL sessions. MaxSslOpenSessions *float64 `json:"max_ssl_open_sessions,omitempty"` // node_obj_id of VserverL7MetricsObj. // Required: true NodeObjID *string `json:"node_obj_id"` // Percentage cache hit of requests. PctCacheHits *float64 `json:"pct_cache_hits,omitempty"` // Percentage cacheable hit of requests. PctCacheableHits *float64 `json:"pct_cacheable_hits,omitempty"` // Number of HTTP GET requests as a percentage of total requests received. Field introduced in 17.2.12, 18.1.2. PctGetReqs *float64 `json:"pct_get_reqs,omitempty"` // Number of HTTP POST requests as a percentage of total requests received. Field introduced in 17.2.12, 18.1.2. PctPostReqs *float64 `json:"pct_post_reqs,omitempty"` // Percent of 4xx and 5xx responses. PctResponseErrors *float64 `json:"pct_response_errors,omitempty"` // Percent of SSL connections failured due to protocol , network or timeout reasons. PctSslFailedConnections *float64 `json:"pct_ssl_failed_connections,omitempty"` // Malicious transactions (Attacks) identified by WAF as the pecentage of total requests received. Field introduced in 17.2.3. PctWafAttacks *float64 `json:"pct_waf_attacks,omitempty"` // Transactions bypassing WAF as the percentage of total requests received. Field introduced in 17.2.12, 18.1.2. PctWafDisabled *float64 `json:"pct_waf_disabled,omitempty"` // WAF evaluated transactions as the pecentage of total requests received. Field introduced in 17.2.2. PctWafEvaluated *float64 `json:"pct_waf_evaluated,omitempty"` // WAF flagged transactions as the percentage of total WAF evaluated transactions. Field introduced in 17.2.2. PctWafFlagged *float64 `json:"pct_waf_flagged,omitempty"` // WAF matched requests as the percentage of total WAF evaluated requests. Field introduced in 17.2.2. PctWafMatched *float64 `json:"pct_waf_matched,omitempty"` // WAF rejected transactions as the percentage of total WAF evaluated transactions. Field introduced in 17.2.2. PctWafRejected *float64 `json:"pct_waf_rejected,omitempty"` // Apdex measures quality of server response based on Real User Metric. RumApdexr *float64 `json:"rum_apdexr,omitempty"` // Protocol strength of SSL ciphers used. SslProtocolStrength *float64 `json:"ssl_protocol_strength,omitempty"` // Total time taken by server to respond to requesti. SumApplicationResponseTime *float64 `json:"sum_application_response_time,omitempty"` // Total time client was blocked. SumBlockingTime *float64 `json:"sum_blocking_time,omitempty"` // Total browser rendering latency reported by client. SumBrowserRenderingTime *float64 `json:"sum_browser_rendering_time,omitempty"` // Average client data transfer time computed by adding response latencies across all HTTP requests. SumClientDataTransferTime *float64 `json:"sum_client_data_transfer_time,omitempty"` // Sum of all client Round Trip Times for all samples. SumClientRtt *float64 `json:"sum_client_rtt,omitempty"` // Total client connection latency reported by client. SumConnectionTime *float64 `json:"sum_connection_time,omitempty"` // Total domain lookup latency reported by client. SumDNSLookupTime *float64 `json:"sum_dns_lookup_time,omitempty"` // Total dom content latency reported by client. SumDomContentLoadTime *float64 `json:"sum_dom_content_load_time,omitempty"` // Count of HTTP 400 and 500 errors for a virtual service in a time interval. SumErrors *float64 `json:"sum_errors,omitempty"` // Number of server sessions closed in this interval. SumFinishedSessions *float64 `json:"sum_finished_sessions,omitempty"` // Total latency from responses to all the GET requests. SumGetClientTxnLatency *float64 `json:"sum_get_client_txn_latency,omitempty"` // Total number of HTTP GET requests that were responded satisfactorily within latency threshold. SumGetClientTxnLatencyBucket1 *float64 `json:"sum_get_client_txn_latency_bucket1,omitempty"` // Total number of HTTP GET requests that were responded beyond latency threshold but within tolerated limits. SumGetClientTxnLatencyBucket2 *float64 `json:"sum_get_client_txn_latency_bucket2,omitempty"` // Total number of HTTP GET requests. SumGetReqs *float64 `json:"sum_get_reqs,omitempty"` // Total size of HTTP request headers. Field introduced in 17.2.12, 18.1.2. SumHTTPHeadersBytes *float64 `json:"sum_http_headers_bytes,omitempty"` // Total number of HTTP headers across all requests in a given metrics interval. Field introduced in 17.2.12, 18.1.2. SumHTTPHeadersCount *float64 `json:"sum_http_headers_count,omitempty"` // Total number of HTTP request parameters. Field introduced in 17.2.12, 18.1.2. SumHTTPParamsCount *float64 `json:"sum_http_params_count,omitempty"` // Total samples that had satisfactory page load time. SumNumPageLoadTimeBucket1 *float64 `json:"sum_num_page_load_time_bucket1,omitempty"` // Total samples that had tolerated page load time. SumNumPageLoadTimeBucket2 *float64 `json:"sum_num_page_load_time_bucket2,omitempty"` // Total samples used for rum metrics. SumNumRumSamples *float64 `json:"sum_num_rum_samples,omitempty"` // Total latency from responses to all the requests other than GET or POST. SumOtherClientTxnLatency *float64 `json:"sum_other_client_txn_latency,omitempty"` // Total number of HTTP requests other than GET or POST that were responded satisfactorily within latency threshold. SumOtherClientTxnLatencyBucket1 *float64 `json:"sum_other_client_txn_latency_bucket1,omitempty"` // Total number of HTTP requests other than GET or POST that were responded beyond latency threshold but within tolerated limits. SumOtherClientTxnLatencyBucket2 *float64 `json:"sum_other_client_txn_latency_bucket2,omitempty"` // Total number of HTTP requests that are not GET or POST requests. SumOtherReqs *float64 `json:"sum_other_reqs,omitempty"` // Total time to transfer response to client. SumPageDownloadTime *float64 `json:"sum_page_download_time,omitempty"` // Total Page Load Time reported by client. SumPageLoadTime *float64 `json:"sum_page_load_time,omitempty"` // Total size of HTTP POST requests. Field introduced in 17.2.12, 18.1.2. SumPostBytes *float64 `json:"sum_post_bytes,omitempty"` // Total latency from responses to all the POST requests. SumPostClientTxnLatency *float64 `json:"sum_post_client_txn_latency,omitempty"` // Total number of HTTP POST requests that were responded satisfactorily within latency threshold. SumPostClientTxnLatencyBucket1 *float64 `json:"sum_post_client_txn_latency_bucket1,omitempty"` // Total number of HTTP POST requests that were responded beyond latency threshold but within tolerated limits. SumPostClientTxnLatencyBucket2 *float64 `json:"sum_post_client_txn_latency_bucket2,omitempty"` // Total number of HTTP POST requests. SumPostReqs *float64 `json:"sum_post_reqs,omitempty"` // Total redirect latency reported by client. SumRedirectionTime *float64 `json:"sum_redirection_time,omitempty"` // Total number of requests served across server sessions closed in the interval. SumReqsFinishedSessions *float64 `json:"sum_reqs_finished_sessions,omitempty"` // Total number of HTTP requests containing at least one parameter. Field introduced in 17.2.12, 18.1.3. SumReqsWithParams *float64 `json:"sum_reqs_with_params,omitempty"` // Total number of HTTP 1XX responses. SumResp1xx *float64 `json:"sum_resp_1xx,omitempty"` // Total number of HTTP 2XX responses. SumResp2xx *float64 `json:"sum_resp_2xx,omitempty"` // Total number of HTTP 3XX responses. SumResp3xx *float64 `json:"sum_resp_3xx,omitempty"` // Total number of HTTP 4XX error responses. SumResp4xx *float64 `json:"sum_resp_4xx,omitempty"` // Total number of HTTP 5XX error responses. SumResp5xx *float64 `json:"sum_resp_5xx,omitempty"` // Total client data transfer time by client. SumRumClientDataTransferTime *float64 `json:"sum_rum_client_data_transfer_time,omitempty"` // Sum of all server Round Trip Times for all samples. SumServerRtt *float64 `json:"sum_server_rtt,omitempty"` // Total time from receipt of request to start of response. SumServiceTime *float64 `json:"sum_service_time,omitempty"` // Total number of HTTP responses sent. SumTotalResponses *float64 `json:"sum_total_responses,omitempty"` // Total length of HTTP request URIs. Field introduced in 17.2.12, 18.1.2. SumURILength *float64 `json:"sum_uri_length,omitempty"` // Total number of transactions identified by WAF as attacks. Field introduced in 17.2.3. SumWafAttacks *float64 `json:"sum_waf_attacks,omitempty"` // Total number of requests bypassing WAF. Field introduced in 17.2.12, 18.1.2. SumWafDisabled *float64 `json:"sum_waf_disabled,omitempty"` // Total number of requests evaluated by WAF in Request Body Phase. Field introduced in 17.2.2. SumWafEvaluatedRequestBodyPhase *float64 `json:"sum_waf_evaluated_request_body_phase,omitempty"` // Total number of requests evaluated by WAF in Request Header Phase. Field introduced in 17.2.2. SumWafEvaluatedRequestHeaderPhase *float64 `json:"sum_waf_evaluated_request_header_phase,omitempty"` // Total number of responses evaluated by WAF in Response Body Phase. Field introduced in 17.2.2. SumWafEvaluatedResponseBodyPhase *float64 `json:"sum_waf_evaluated_response_body_phase,omitempty"` // Total number of responses evaluated by WAF in Response Header Phase. Field introduced in 17.2.2. SumWafEvaluatedResponseHeaderPhase *float64 `json:"sum_waf_evaluated_response_header_phase,omitempty"` // Total number of transactions (requests or responses) flagged as attack by WAF. Field introduced in 17.2.3. SumWafFlagged *float64 `json:"sum_waf_flagged,omitempty"` // Total number of requests flagged (but not rejected) by WAF in Request Body Phase. Field introduced in 17.2.2. SumWafFlaggedRequestBodyPhase *float64 `json:"sum_waf_flagged_request_body_phase,omitempty"` // Total number of requests flagged (but not rejected) by WAF in Request Header Phase. Field introduced in 17.2.2. SumWafFlaggedRequestHeaderPhase *float64 `json:"sum_waf_flagged_request_header_phase,omitempty"` // Total number of responses flagged (but not rejected) by WAF in Response Body Phase. Field introduced in 17.2.2. SumWafFlaggedResponseBodyPhase *float64 `json:"sum_waf_flagged_response_body_phase,omitempty"` // Total number of responses flagged (but not rejected) by WAF in Response Header Phase. Field introduced in 17.2.2. SumWafFlaggedResponseHeaderPhase *float64 `json:"sum_waf_flagged_response_header_phase,omitempty"` // Total latency seen by all evaluated requests in Request Body Phase. Field introduced in 17.2.2. SumWafLatencyRequestBodyPhase *float64 `json:"sum_waf_latency_request_body_phase,omitempty"` // Total latency seen by all transactions evaluated by WAF in Request Header Phase. Field introduced in 17.2.2. SumWafLatencyRequestHeaderPhase *float64 `json:"sum_waf_latency_request_header_phase,omitempty"` // Total latency seen by all evaluated responses in Response Body Phase. Field introduced in 17.2.2. SumWafLatencyResponseBodyPhase *float64 `json:"sum_waf_latency_response_body_phase,omitempty"` // Total latency seen by all evaluated responsess in WAF Response Header Phase. Field introduced in 17.2.2. SumWafLatencyResponseHeaderPhase *float64 `json:"sum_waf_latency_response_header_phase,omitempty"` // Total number of requests matched by WAF in Request Body Phase. Field introduced in 17.2.2. SumWafMatchedRequestBodyPhase *float64 `json:"sum_waf_matched_request_body_phase,omitempty"` // Total number of requests matched by WAF in Request Header Phase. Field introduced in 17.2.2. SumWafMatchedRequestHeaderPhase *float64 `json:"sum_waf_matched_request_header_phase,omitempty"` // Total number of responses matched by WAF in Response Body Phase. Field introduced in 17.2.2. SumWafMatchedResponseBodyPhase *float64 `json:"sum_waf_matched_response_body_phase,omitempty"` // Total number of responses matched by WAF in Response Header Phase. Field introduced in 17.2.2. SumWafMatchedResponseHeaderPhase *float64 `json:"sum_waf_matched_response_header_phase,omitempty"` // Total number of transactions (requests or responses) rejected by WAF. Field introduced in 17.2.3. SumWafRejected *float64 `json:"sum_waf_rejected,omitempty"` // Total number of requests rejected by WAF in Request Body Phase. Field introduced in 17.2.2. SumWafRejectedRequestBodyPhase *float64 `json:"sum_waf_rejected_request_body_phase,omitempty"` // Total number of requests rejected by WAF in Request Header Phase. Field introduced in 17.2.2. SumWafRejectedRequestHeaderPhase *float64 `json:"sum_waf_rejected_request_header_phase,omitempty"` // Total number of responses rejected by WAF in Response Body Phase. Field introduced in 17.2.2. SumWafRejectedResponseBodyPhase *float64 `json:"sum_waf_rejected_response_body_phase,omitempty"` // Total number of responses rejected by WAF in Response Header Phase. Field introduced in 17.2.2. SumWafRejectedResponseHeaderPhase *float64 `json:"sum_waf_rejected_response_header_phase,omitempty"` // Total waiting reported by client. SumWaitingTime *float64 `json:"sum_waiting_time,omitempty"` }
VserverL7MetricsObj vserver l7 metrics obj swagger:model VserverL7MetricsObj
type VssPlacement ¶
type VssPlacement struct { // Degree of core non-affinity for VS placement. Allowed values are 1-256. Field introduced in 17.2.5. CoreNonaffinity *int32 `json:"core_nonaffinity,omitempty"` // Number of sub-cores that comprise a CPU core. Allowed values are 1-128. Field introduced in 17.2.5. NumSubcores *int32 `json:"num_subcores,omitempty"` }
VssPlacement vss placement swagger:model VssPlacement
type WafAllowlistLog ¶
type WafAllowlistLog struct { // Actions generated by this rule. Enum options - WAF_POLICY_ALLOWLIST_ACTION_BYPASS, WAF_POLICY_ALLOWLIST_ACTION_DETECTION_MODE, WAF_POLICY_ALLOWLIST_ACTION_CONTINUE. Field introduced in 20.1.3. Actions []string `json:"actions,omitempty"` // Name of the matched rule. Field introduced in 20.1.3. RuleName *string `json:"rule_name,omitempty"` }
WafAllowlistLog waf allowlist log swagger:model WafAllowlistLog
type WafApplicationSignatureAppVersion ¶
type WafApplicationSignatureAppVersion struct { // Name of an application in the rule set. Field introduced in 20.1.1. // Read Only: true Application *string `json:"application,omitempty"` // The last version of the rule set when the rules corresponding to the application changed. Field introduced in 20.1.1. // Read Only: true LastChangedRulesetVersion *string `json:"last_changed_ruleset_version,omitempty"` // The number of rules available for this application. Field introduced in 20.1.3. // Read Only: true NumberOfRules *int32 `json:"number_of_rules,omitempty"` }
WafApplicationSignatureAppVersion waf application signature app version swagger:model WafApplicationSignatureAppVersion
type WafApplicationSignatureProvider ¶
type WafApplicationSignatureProvider struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Available application names and the ruleset version, when the rules for an application changed the last time. Field introduced in 20.1.1. // Read Only: true AvailableApplications []*WafApplicationSignatureAppVersion `json:"available_applications,omitempty"` // The error message indicating why the last update check failed. Field deprecated in 20.1.3. Field introduced in 20.1.1. // Read Only: true LastCheckForUpdatesError *string `json:"last_check_for_updates_error,omitempty"` // The last time that we checked for updates but did not get a result because of an error. Field deprecated in 20.1.3. Field introduced in 20.1.1. // Read Only: true LastFailedCheckForUpdates *TimeStamp `json:"last_failed_check_for_updates,omitempty"` // The last time that we checked for updates sucessfully. Field deprecated in 20.1.3. Field introduced in 20.1.1. // Read Only: true LastSuccessfulCheckForUpdates *TimeStamp `json:"last_successful_check_for_updates,omitempty"` // Name of Application Specific Ruleset Provider. Field introduced in 20.1.1. Name *string `json:"name,omitempty"` // Version of signatures. Field introduced in 20.1.1. // Read Only: true RulesetVersion *string `json:"ruleset_version,omitempty"` // If this object is managed by the Application Signatures update service, this field contain the status of this syncronization. Field introduced in 20.1.3. ServiceStatus *WebApplicationSignatureServiceStatus `json:"service_status,omitempty"` // The WAF rules. Not visible in the API. Field introduced in 20.1.1. // Read Only: true Signatures []*WafRule `json:"signatures,omitempty"` // It is a reference to an object of type Tenant. Field introduced in 20.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 20.1.1. UUID *string `json:"uuid,omitempty"` }
WafApplicationSignatureProvider waf application signature provider swagger:model WafApplicationSignatureProvider
type WafApplicationSignatureProviderAPIResponse ¶
type WafApplicationSignatureProviderAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*WafApplicationSignatureProvider `json:"results,omitempty"` }
WafApplicationSignatureProviderAPIResponse waf application signature provider Api response swagger:model WafApplicationSignatureProviderApiResponse
type WafApplicationSignatures ¶
type WafApplicationSignatures struct { // The external provide for the rules. It is a reference to an object of type WafApplicationSignatureProvider. Field introduced in 20.1.1. // Required: true ProviderRef *string `json:"provider_ref"` // The active application specific rules. You can change attributes like enabled, waf mode and exclusions, but not the rules itself. To change the rules, you can change the tags or the rule provider. Field introduced in 20.1.1. Rules []*WafRule `json:"rules,omitempty"` // The version in use of the provided ruleset. Field introduced in 20.1.1. // Read Only: true RulesetVersion *string `json:"ruleset_version,omitempty"` // List of applications for which we use the rules from the WafApplicationSignatureProvider. Field introduced in 20.1.1. Maximum of 8 items allowed. SelectedApplications []string `json:"selected_applications,omitempty"` }
WafApplicationSignatures waf application signatures swagger:model WafApplicationSignatures
type WafCRS ¶
type WafCRS struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // A short description of this ruleset. Field introduced in 18.1.1. // Required: true Description *string `json:"description"` // WAF Rules are sorted in groups based on their characterization. Field introduced in 18.1.1. Maximum of 64 items allowed. Groups []*WafRuleGroup `json:"groups,omitempty"` // Integrity protection value. Field introduced in 18.2.1. // Required: true Integrity *string `json:"integrity"` // The name of this ruleset object. Field introduced in 18.2.1. // Required: true Name *string `json:"name"` // The release date of this version in RFC 3339 / ISO 8601 format. Field introduced in 18.1.1. // Required: true ReleaseDate *string `json:"release_date"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 18.1.1. UUID *string `json:"uuid,omitempty"` // The version of this ruleset object. Field introduced in 18.1.1. // Required: true Version *string `json:"version"` }
WafCRS waf c r s swagger:model WafCRS
type WafCRSAPIResponse ¶
type WafCRSAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*WafCRS `json:"results,omitempty"` }
WafCRSAPIResponse waf c r s Api response swagger:model WafCRSApiResponse
type WafConfig ¶
type WafConfig struct { // WAF allowed HTTP Versions. Enum options - ZERO_NINE, ONE_ZERO, ONE_ONE, TWO_ZERO. Field introduced in 17.2.1. Maximum of 8 items allowed. AllowedHTTPVersions []string `json:"allowed_http_versions,omitempty"` // WAF allowed HTTP methods. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 17.2.1. AllowedMethods []string `json:"allowed_methods,omitempty"` // WAF allowed Content Types. Field introduced in 17.2.1. Maximum of 64 items allowed. AllowedRequestContentTypes []string `json:"allowed_request_content_types,omitempty"` // Argument seperator. Field introduced in 17.2.1. ArgumentSeparator *string `json:"argument_separator,omitempty"` // Enable to buffer response body for inspection. Field deprecated in 18.2.2. Field introduced in 17.2.3. BufferResponseBodyForInspection *bool `json:"buffer_response_body_for_inspection,omitempty"` // Maximum size for the client request body for file uploads. Allowed values are 1-32768. Field deprecated in 18.1.5. Field introduced in 17.2.1. Unit is KB. ClientFileUploadMaxBodySize *int32 `json:"client_file_upload_max_body_size,omitempty"` // Maximum size for the client request body for non-file uploads. Allowed values are 1-32768. Field deprecated in 18.1.5. Field introduced in 17.2.1. Unit is KB. ClientNonfileUploadMaxBodySize *int32 `json:"client_nonfile_upload_max_body_size,omitempty"` // Maximum size for the client request body scanned by WAF. Allowed values are 1-32768. Field introduced in 18.1.5, 18.2.1. Unit is KB. ClientRequestMaxBodySize *int32 `json:"client_request_max_body_size,omitempty"` // Deprecated (Moved to WafPolicy). Configure thresholds for confidence labels. Field deprecated in 20.1.1. Field introduced in 18.2.3. ConfidenceOverride *AppLearningConfidenceOverride `json:"confidence_override,omitempty"` // 0 For Netscape Cookies. 1 For version 1 cookies. Allowed values are 0-1. Field introduced in 17.2.1. CookieFormatVersion *int32 `json:"cookie_format_version,omitempty"` // Deprecated (Moved to WafPolicy). Enable Application Learning based rule updates on the WAF Profile. Rules will be programmed in dedicated WAF learning group. Field deprecated in 20.1.1. Field introduced in 18.2.3. EnableAutoRuleUpdates *bool `json:"enable_auto_rule_updates,omitempty"` // Ignore request body parsing errors due to partial scanning. Field introduced in 18.1.5, 18.2.1. IgnoreIncompleteRequestBodyError *bool `json:"ignore_incomplete_request_body_error,omitempty"` // Deprecated (Moved to WafPolicy). Parameters for tuning Application learning. Field deprecated in 20.1.1. Field introduced in 18.2.3. LearningParams *AppLearningParams `json:"learning_params,omitempty"` // The maximum period of time WAF processing is allowed to take for a single request. A value of 0 (zero) means no limit and should not be chosen in production deployments. It is only used for exceptional situations where crashes of se_dp processes are acceptable. The behavior of the system if this time is exceeded depends on two other configuration settings, the WAF policy mode and the WAF failure mode. In WAF policy mode 'Detection', the request is allowed and flagged for both failure mode 'Closed' and 'Open'. In enforcement node, 'Closed' means the request is rejected, 'Open' means the request is allowed and flagged. Irrespective of these settings, no subsequent WAF rules of this or other phases will be executed once the maximum execution time has been exceeded. Allowed values are 0-5000. Field introduced in 17.2.12, 18.1.2. Unit is MILLISECONDS. MaxExecutionTime *int32 `json:"max_execution_time,omitempty"` // Deprecated (Moved to WafPolicy) Minimum confidence label required for auto rule updates. Enum options - CONFIDENCE_VERY_HIGH, CONFIDENCE_HIGH, CONFIDENCE_PROBABLE, CONFIDENCE_LOW, CONFIDENCE_NONE. Field deprecated in 20.1.1. Field introduced in 18.2.3. MinConfidence *string `json:"min_confidence,omitempty"` // Limit CPU utilization for each regular expression match when processing rules. Field introduced in 17.2.5. RegexMatchLimit *int32 `json:"regex_match_limit,omitempty"` // Limit depth of recursion for each regular expression match when processing rules. Field introduced in 18.2.9. RegexRecursionLimit *int32 `json:"regex_recursion_limit,omitempty"` // WAF default action for Request Body Phase. Field introduced in 17.2.1. // Required: true RequestBodyDefaultAction *string `json:"request_body_default_action"` // WAF default action for Request Header Phase. Field introduced in 17.2.1. // Required: true RequestHdrDefaultAction *string `json:"request_hdr_default_action"` // WAF default action for Response Body Phase. Field introduced in 17.2.1. // Required: true ResponseBodyDefaultAction *string `json:"response_body_default_action"` // WAF default action for Response Header Phase. Field introduced in 17.2.1. // Required: true ResponseHdrDefaultAction *string `json:"response_hdr_default_action"` // WAF Restricted File Extensions. Field introduced in 17.2.1. Maximum of 256 items allowed. RestrictedExtensions []string `json:"restricted_extensions,omitempty"` // WAF Restricted HTTP Headers. Field introduced in 17.2.1. Maximum of 64 items allowed. RestrictedHeaders []string `json:"restricted_headers,omitempty"` // Whether or not to send WAF status in a request header to pool servers. Field introduced in 20.1.3. SendStatusHeader *bool `json:"send_status_header,omitempty"` // Maximum size for response body scanned by WAF. Allowed values are 1-32768. Field introduced in 17.2.1. Unit is KB. ServerResponseMaxBodySize *int32 `json:"server_response_max_body_size,omitempty"` // WAF Static File Extensions. GET and HEAD requests with no query args and one of these extensions are allowed and not checked by the ruleset. Field introduced in 17.2.5. Maximum of 64 items allowed. StaticExtensions []string `json:"static_extensions,omitempty"` // HTTP status code used by WAF Positive Security Model when rejecting a request. Enum options - HTTP_RESPONSE_CODE_0, HTTP_RESPONSE_CODE_100, HTTP_RESPONSE_CODE_101, HTTP_RESPONSE_CODE_200, HTTP_RESPONSE_CODE_201, HTTP_RESPONSE_CODE_202, HTTP_RESPONSE_CODE_203, HTTP_RESPONSE_CODE_204, HTTP_RESPONSE_CODE_205, HTTP_RESPONSE_CODE_206, HTTP_RESPONSE_CODE_300, HTTP_RESPONSE_CODE_301, HTTP_RESPONSE_CODE_302, HTTP_RESPONSE_CODE_303, HTTP_RESPONSE_CODE_304, HTTP_RESPONSE_CODE_305, HTTP_RESPONSE_CODE_307, HTTP_RESPONSE_CODE_400, HTTP_RESPONSE_CODE_401, HTTP_RESPONSE_CODE_402.... Field introduced in 18.2.3. StatusCodeForRejectedRequests *string `json:"status_code_for_rejected_requests,omitempty"` // The name of the request header indicating WAF evaluation status to pool servers. Field introduced in 20.1.3. StatusHeaderName *string `json:"status_header_name,omitempty"` // Block or flag XML requests referring to External Entities. Field introduced in 20.1.1. XMLXxeProtection *bool `json:"xml_xxe_protection,omitempty"` }
WafConfig waf config swagger:model WafConfig
type WafDataFile ¶
type WafDataFile struct { // Stringified WAF File Data. Field introduced in 17.2.1. // Required: true Data *string `json:"data"` // WAF Data File Name. Field introduced in 17.2.1. // Required: true Name *string `json:"name"` // WAF data file type. Enum options - WAF_DATAFILE_PM_FROM_FILE, WAF_DATAFILE_DTD, WAF_DATAFILE_XSD. Field introduced in 20.1.1. Type *string `json:"type,omitempty"` }
WafDataFile waf data file swagger:model WafDataFile
type WafExcludeListEntry ¶
type WafExcludeListEntry struct { // Client IP Subnet to exclude for WAF rules. Field introduced in 17.2.1. ClientSubnet *IPAddrPrefix `json:"client_subnet,omitempty"` // Free-text comment about this exclusion. Field introduced in 18.2.6. Description *string `json:"description,omitempty"` // The match_element can be 'ARGS xxx', 'ARGS_GET xxx', 'ARGS_POST xxx', 'ARGS_NAMES xxx', 'FILES xxx', 'QUERY_STRING', 'REQUEST_BASENAME', 'REQUEST_BODY', 'REQUEST_URI', 'REQUEST_URI_RAW', 'REQUEST_COOKIES xxx', 'REQUEST_HEADERS xxx' or 'RESPONSE_HEADERS xxx'. These match_elements in the HTTP Transaction (if present) will be excluded when executing WAF Rules. Field introduced in 17.2.1. MatchElement *string `json:"match_element,omitempty"` // Criteria for match_element matching. Field introduced in 18.2.2. MatchElementCriteria *WafExclusionType `json:"match_element_criteria,omitempty"` // Criteria for URI matching. Field introduced in 17.2.8. URIMatchCriteria *WafExclusionType `json:"uri_match_criteria,omitempty"` // URI Path to exclude for WAF rules. Field introduced in 17.2.1. URIPath *string `json:"uri_path,omitempty"` }
WafExcludeListEntry waf exclude list entry swagger:model WafExcludeListEntry
type WafExclusionType ¶
type WafExclusionType struct { // Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE. Field introduced in 17.2.8. // Required: true MatchCase *string `json:"match_case"` // String Operation to use for matching the Exclusion. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Field introduced in 17.2.8. // Required: true MatchOp *string `json:"match_op"` }
WafExclusionType waf exclusion type swagger:model WafExclusionType
type WafLearning ¶
type WafLearning struct { // Suffix Summarization threshold used to compress args. Allowed values are 3-255. Field deprecated in 18.2.3. Field introduced in 18.1.2. ArgSummarizationThreshold *int32 `json:"arg_summarization_threshold,omitempty"` // Confidence level used to derive rules from the WAF learning. Allowed values are 60-100. Field deprecated in 18.2.3. Field introduced in 18.1.2. Unit is PERCENT. Confidence *int32 `json:"confidence,omitempty"` // Enable Learning for WAF policy. Field deprecated in 18.2.3. Field introduced in 18.1.2. Enable *bool `json:"enable,omitempty"` // Suffix Summarization threshold used to compress paths. Allowed values are 3-255. Field deprecated in 18.2.3. Field introduced in 18.1.2. PathSummarizationThreshold *int32 `json:"path_summarization_threshold,omitempty"` // Sampling percent of the requests subjected to WAF learning. Allowed values are 1-100. Field deprecated in 18.2.3. Field introduced in 18.1.2. Unit is PERCENT. SamplingPercent *int32 `json:"sampling_percent,omitempty"` }
WafLearning waf learning swagger:model WafLearning
type WafLog ¶
type WafLog struct { // Set to true if there are allowlist rules in the policy. Field introduced in 20.1.3. AllowlistConfigured *bool `json:"allowlist_configured,omitempty"` // Log Entries generated by WAF allowlist rules. Field introduced in 20.1.3. AllowlistLogs []*WafAllowlistLog `json:"allowlist_logs,omitempty"` // Set to true if allowlist rules were processed. Field introduced in 20.1.3. AllowlistProcessed *bool `json:"allowlist_processed,omitempty"` // Log Entries generated by Application Specific Signature rules. Field introduced in 20.1.1. ApplicationRuleLogs []*WafRuleLog `json:"application_rule_logs,omitempty"` // Set to true if there are Application Specific Signature rules in the policy. Field introduced in 20.1.1. ApplicationRulesConfigured *bool `json:"application_rules_configured,omitempty"` // Set to true if Application Specific Signature rules were executed. Field deprecated in 20.1.3. Field introduced in 20.1.1. ApplicationRulesExecuted *bool `json:"application_rules_executed,omitempty"` // Set to true if Application Specific Signature rules were processed. Field introduced in 20.1.3. ApplicationRulesProcessed *bool `json:"application_rules_processed,omitempty"` // Latency (in microseconds) in WAF Request Body Phase. Field introduced in 17.2.2. LatencyRequestBodyPhase *int64 `json:"latency_request_body_phase,omitempty"` // Latency (in microseconds) in WAF Request Header Phase. Field introduced in 17.2.2. LatencyRequestHeaderPhase *int64 `json:"latency_request_header_phase,omitempty"` // Latency (in microseconds) in WAF Response Body Phase. Field introduced in 17.2.2. LatencyResponseBodyPhase *int64 `json:"latency_response_body_phase,omitempty"` // Latency (in microseconds) in WAF Response Header Phase. Field introduced in 17.2.2. LatencyResponseHeaderPhase *int64 `json:"latency_response_header_phase,omitempty"` // Set to true if there are Positive Security Model rules in the policy. Field introduced in 18.2.3. PsmConfigured *bool `json:"psm_configured,omitempty"` // Set to true if Positive Security Model rules were executed. Field deprecated in 20.1.3. Field introduced in 18.2.3. PsmExecuted *bool `json:"psm_executed,omitempty"` // Log Entries generated by WAF Positive Security Model. Field introduced in 18.2.3. PsmLogs []*WafPSMLog `json:"psm_logs,omitempty"` // Set to true if Positive Security Model rules were processed. Field introduced in 20.1.3. PsmProcessed *bool `json:"psm_processed,omitempty"` // Field introduced in 17.2.1. RuleLogs []*WafRuleLog `json:"rule_logs,omitempty"` // Set to true if there are ModSecurity rules in the policy. Field introduced in 18.2.3. RulesConfigured *bool `json:"rules_configured,omitempty"` // Set to true if ModSecurity rules were executed. Field deprecated in 20.1.3. Field introduced in 18.2.3. RulesExecuted *bool `json:"rules_executed,omitempty"` // Set to true if ModSecurity rules were processed. Field introduced in 20.1.3. RulesProcessed *bool `json:"rules_processed,omitempty"` // Denotes whether WAF is running in detection mode or enforcement mode, whether any rules matched the transaction, and whether transaction is dropped by the WAF module. Enum options - NO_WAF, FLAGGED, PASSED, REJECTED, WHITELISTED, BYPASSED. Field introduced in 17.2.2. Status *string `json:"status,omitempty"` // Set to true if there are whitelist rules in the policy. Field deprecated in 20.1.3. Field introduced in 18.2.3. WhitelistConfigured *bool `json:"whitelist_configured,omitempty"` // Set to true if whitelist rules were executed. Field deprecated in 20.1.3. Field introduced in 18.2.3. WhitelistExecuted *bool `json:"whitelist_executed,omitempty"` // Log Entries generated by WAF whitelist rules. Field deprecated in 20.1.3. Field introduced in 18.2.3. WhitelistLogs []*WafWhitelistLog `json:"whitelist_logs,omitempty"` }
WafLog waf log swagger:model WafLog
type WafPSMLocation ¶
type WafPSMLocation struct { // Free-text comment about this location. Field introduced in 18.2.3. Description *string `json:"description,omitempty"` // Location index, this is used to determine the order of the locations. Field introduced in 18.2.3. // Required: true Index *int32 `json:"index"` // Apply these rules only if the request is matching this description. Field introduced in 18.2.3. Match *WafPSMLocationMatch `json:"match,omitempty"` // User defined name for this location, it must be unique in the group. Field introduced in 18.2.3. // Required: true Name *string `json:"name"` // A list of rules which should be applied on this location. Field introduced in 18.2.3. Maximum of 1024 items allowed. Rules []*WafPSMRule `json:"rules,omitempty"` }
WafPSMLocation waf p s m location swagger:model WafPSMLocation
type WafPSMLocationMatch ¶
type WafPSMLocationMatch struct { // Apply the rules only to requests that match the specified Host header. If this is not set, the host header will not be checked. Field introduced in 18.2.3. Host *HostHdrMatch `json:"host,omitempty"` // Apply the rules only to requests that have the specified methods. If this is not set, the method will not be checked. Field introduced in 18.2.3. Methods *MethodMatch `json:"methods,omitempty"` // Apply the rules only to requests that match the specified URI. If this is not set, the path will not be checked. Field introduced in 18.2.3. Path *PathMatch `json:"path,omitempty"` }
WafPSMLocationMatch waf p s m location match swagger:model WafPSMLocationMatch
type WafPSMLog ¶
type WafPSMLog struct { // Actions generated by this rule. Enum options - WAF_ACTION_NO_OP, WAF_ACTION_BLOCK, WAF_ACTION_ALLOW_PARAMETER. Field introduced in 18.2.3. Actions []string `json:"actions,omitempty"` // Name of the PSM group. Field introduced in 18.2.3. GroupName *string `json:"group_name,omitempty"` // UUID of the PSM group. Field introduced in 18.2.3. GroupUUID *string `json:"group_uuid,omitempty"` // Name of the PSM location. Field introduced in 18.2.3. Location *string `json:"location,omitempty"` // Transaction data that matched the rule. Field introduced in 18.2.3. Matches []*WafRuleMatchData `json:"matches,omitempty"` // Rule ID of the matching rule. Field introduced in 18.2.3. RuleID *string `json:"rule_id,omitempty"` // Name of the matching rule. Field introduced in 18.2.3. RuleName *string `json:"rule_name,omitempty"` }
WafPSMLog waf p s m log swagger:model WafPSMLog
type WafPSMMatchElement ¶
type WafPSMMatchElement struct { // Mark this element excluded, like in '!ARGS password'. Field introduced in 18.2.3. Excluded *bool `json:"excluded,omitempty"` // Match_element index. Field introduced in 18.2.3. // Required: true Index *int32 `json:"index"` // The variable specification. For example ARGS or REQUEST_COOKIES. This can be a scalar like PATH_INFO. Enum options - WAF_VARIABLE_ARGS, WAF_VARIABLE_ARGS_GET, WAF_VARIABLE_ARGS_POST, WAF_VARIABLE_ARGS_NAMES, WAF_VARIABLE_REQUEST_COOKIES, WAF_VARIABLE_QUERY_STRING, WAF_VARIABLE_REQUEST_BASENAME, WAF_VARIABLE_REQUEST_URI, WAF_VARIABLE_PATH_INFO. Field introduced in 18.2.3. // Required: true Name *string `json:"name"` // The name of the request collection element. This can be empty, if we address the whole collection or a scalar element. Field introduced in 18.2.3. SubElement *string `json:"sub_element,omitempty"` }
WafPSMMatchElement waf p s m match element swagger:model WafPSMMatchElement
type WafPSMRule ¶
type WafPSMRule struct { // Free-text comment about this rule. Field introduced in 18.2.3. Description *string `json:"description,omitempty"` // Enable or disable this rule. Field introduced in 18.2.3. Enable *bool `json:"enable,omitempty"` // Rule index, this is used to determine the order of the rules. Field introduced in 18.2.3. // Required: true Index *int32 `json:"index"` // The field match_value_pattern regular expression is case sensitive. Enum options - SENSITIVE, INSENSITIVE. Field introduced in 18.2.3. MatchCase *string `json:"match_case,omitempty"` // The match elements, for example ARGS id or ARGS|!ARGS password. Field introduced in 18.2.3. Maximum of 64 items allowed. MatchElements []*WafPSMMatchElement `json:"match_elements,omitempty"` // The maximum allowed length of the match_value. If this is not set, the length will not be checked. Field introduced in 18.2.3. MatchValueMaxLength *int32 `json:"match_value_max_length,omitempty"` // A regular expression which describes the expected value. Field introduced in 18.2.3. MatchValuePattern *string `json:"match_value_pattern,omitempty"` // If match_value_string_group_uuid and match_value_string_group_key are set, the referenced regular expression is used as match_value_pattern. Field introduced in 20.1.3. MatchValueStringGroupKey *string `json:"match_value_string_group_key,omitempty"` // The UUID of a *string group containing key used in match_value_string_group_key. It is a reference to an object of type StringGroup. Field introduced in 20.1.3. MatchValueStringGroupRef *string `json:"match_value_string_group_ref,omitempty"` // WAF Rule mode. This can be detection or enforcement. If this is not set, the Policy mode is used. This only takes effect if the policy allows delegation. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT. Field introduced in 18.2.3. Mode *string `json:"mode,omitempty"` // Name of the rule. Field introduced in 18.2.3. // Required: true Name *string `json:"name"` // WAF Ruleset paranoia mode. This is used to select Rules based on the paranoia-level. Enum options - WAF_PARANOIA_LEVEL_LOW, WAF_PARANOIA_LEVEL_MEDIUM, WAF_PARANOIA_LEVEL_HIGH, WAF_PARANOIA_LEVEL_EXTREME. Field introduced in 18.2.3. ParanoiaLevel *string `json:"paranoia_level,omitempty"` // Id field which is used for log and metric generation. This id must be unique for all rules in this group. Field introduced in 18.2.3. // Required: true RuleID *string `json:"rule_id"` }
WafPSMRule waf p s m rule swagger:model WafPSMRule
type WafPolicy ¶
type WafPolicy struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Allow Rules to overwrite the policy mode. This must be set if the policy mode is set to enforcement. Field introduced in 18.1.5, 18.2.1. AllowModeDelegation *bool `json:"allow_mode_delegation,omitempty"` // A set of rules which describe conditions under which the request will bypass the WAF. This will be processed in the request header phase before any other WAF related code. Field introduced in 20.1.3. Allowlist *WafPolicyAllowlist `json:"allowlist,omitempty"` // Application Specific Signatures. Field introduced in 20.1.1. ApplicationSignatures *WafApplicationSignatures `json:"application_signatures,omitempty"` // Configure thresholds for confidence labels. Field introduced in 20.1.1. ConfidenceOverride *AppLearningConfidenceOverride `json:"confidence_override,omitempty"` // Creator name. Field introduced in 17.2.4. CreatedBy *string `json:"created_by,omitempty"` // WAF Rules are categorized in to groups based on their characterization. These groups are system created with CRS groups. Field introduced in 17.2.1. CrsGroups []*WafRuleGroup `json:"crs_groups,omitempty"` // Field introduced in 17.2.1. Description *string `json:"description,omitempty"` // Enable Application Learning for this WAF policy. Field introduced in 18.2.3. EnableAppLearning *bool `json:"enable_app_learning,omitempty"` // Enable Application Learning based rule updates on the WAF Profile. Rules will be programmed in dedicated WAF learning group. Field introduced in 20.1.1. EnableAutoRuleUpdates *bool `json:"enable_auto_rule_updates,omitempty"` // Enable dynamic regex generation for positive security model rules. This is an experimental feature and shouldn't be used in production. Field introduced in 20.1.1. EnableRegexLearning *bool `json:"enable_regex_learning,omitempty"` // WAF Policy failure mode. This can be 'Open' or 'Closed'. Enum options - WAF_FAILURE_MODE_OPEN, WAF_FAILURE_MODE_CLOSED. Field introduced in 18.1.2. FailureMode *string `json:"failure_mode,omitempty"` // Geo Location Mapping Database used by this WafPolicy. It is a reference to an object of type GeoDB. Field introduced in 21.1.1. GeoDbRef *string `json:"geo_db_ref,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Configure parameters for WAF learning. Field deprecated in 18.2.3. Field introduced in 18.1.2. Learning *WafLearning `json:"learning,omitempty"` // Parameters for tuning Application learning. Field introduced in 20.1.1. LearningParams *AppLearningParams `json:"learning_params,omitempty"` // Minimum confidence label required for auto rule updates. Enum options - CONFIDENCE_VERY_HIGH, CONFIDENCE_HIGH, CONFIDENCE_PROBABLE, CONFIDENCE_LOW, CONFIDENCE_NONE. Field introduced in 20.1.1. MinConfidence *string `json:"min_confidence,omitempty"` // WAF Policy mode. This can be detection or enforcement. It can be overwritten by rules if allow_mode_delegation is set. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT. Field introduced in 17.2.1. // Required: true Mode *string `json:"mode"` // Field introduced in 17.2.1. // Required: true Name *string `json:"name"` // WAF Ruleset paranoia mode. This is used to select Rules based on the paranoia-level tag. Enum options - WAF_PARANOIA_LEVEL_LOW, WAF_PARANOIA_LEVEL_MEDIUM, WAF_PARANOIA_LEVEL_HIGH, WAF_PARANOIA_LEVEL_EXTREME. Field introduced in 17.2.1. ParanoiaLevel *string `json:"paranoia_level,omitempty"` // The Positive Security Model. This is used to describe how the request or parts of the request should look like. It is executed in the Request Body Phase of Avi WAF. Field introduced in 18.2.3. PositiveSecurityModel *WafPositiveSecurityModel `json:"positive_security_model,omitempty"` // WAF Rules are categorized in to groups based on their characterization. These groups are created by the user and will be enforced after the CRS groups. Field introduced in 17.2.1. PostCrsGroups []*WafRuleGroup `json:"post_crs_groups,omitempty"` // WAF Rules are categorized in to groups based on their characterization. These groups are created by the user and will be enforced before the CRS groups. Field introduced in 17.2.1. PreCrsGroups []*WafRuleGroup `json:"pre_crs_groups,omitempty"` // It is a reference to an object of type Tenant. Field introduced in 17.2.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 17.2.1. UUID *string `json:"uuid,omitempty"` // WAF core ruleset used for the CRS part of this Policy. It is a reference to an object of type WafCRS. Field introduced in 18.1.1. WafCrsRef *string `json:"waf_crs_ref,omitempty"` // WAF Profile for WAF policy. It is a reference to an object of type WafProfile. Field introduced in 17.2.1. // Required: true WafProfileRef *string `json:"waf_profile_ref"` // A set of rules which describe conditions under which the request will bypass the WAF. This will be executed in the request header phase before any other WAF related code. Field deprecated in 20.1.3. Field introduced in 18.2.3. Whitelist *WafPolicyWhitelist `json:"whitelist,omitempty"` }
WafPolicy waf policy swagger:model WafPolicy
type WafPolicyAPIResponse ¶
type WafPolicyAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*WafPolicy `json:"results,omitempty"` }
WafPolicyAPIResponse waf policy Api response swagger:model WafPolicyApiResponse
type WafPolicyAllowlist ¶
type WafPolicyAllowlist struct { // Rules to bypass WAF. Field introduced in 20.1.3. Maximum of 1024 items allowed. Rules []*WafPolicyAllowlistRule `json:"rules,omitempty"` }
WafPolicyAllowlist waf policy allowlist swagger:model WafPolicyAllowlist
type WafPolicyAllowlistRule ¶
type WafPolicyAllowlistRule struct { // Actions to be performed upon successful matching. Enum options - WAF_POLICY_ALLOWLIST_ACTION_BYPASS, WAF_POLICY_ALLOWLIST_ACTION_DETECTION_MODE, WAF_POLICY_ALLOWLIST_ACTION_CONTINUE. Field introduced in 20.1.3. Minimum of 1 items required. Maximum of 1 items allowed. Actions []string `json:"actions,omitempty"` // Description of this rule. Field introduced in 20.1.3. Description *string `json:"description,omitempty"` // Enable or deactivate the rule. Field introduced in 20.1.3. Enable *bool `json:"enable,omitempty"` // Rules are processed in order of this index field. Field introduced in 20.1.3. // Required: true Index *int32 `json:"index"` // Match criteria describing requests to which this rule should be applied. Field introduced in 20.1.3. // Required: true Match *MatchTarget `json:"match"` // A name describing the rule in a short form. Field introduced in 20.1.3. // Required: true Name *string `json:"name"` // Percentage of traffic that is sampled. Allowed values are 0-100. Field introduced in 20.1.3. Unit is PERCENT. SamplingPercent *int32 `json:"sampling_percent,omitempty"` }
WafPolicyAllowlistRule waf policy allowlist rule swagger:model WafPolicyAllowlistRule
type WafPolicyPSMGroup ¶
type WafPolicyPSMGroup struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Free-text comment about this group. Field introduced in 18.2.3. Description *string `json:"description,omitempty"` // Enable or disable this WAF rule group. Field introduced in 18.2.3. Enable *bool `json:"enable,omitempty"` // If a rule in this group matches the match_value pattern, this action will be executed. Allowed actions are WAF_ACTION_NO_OP and WAF_ACTION_ALLOW_PARAMETER. Enum options - WAF_ACTION_NO_OP, WAF_ACTION_BLOCK, WAF_ACTION_ALLOW_PARAMETER. Field introduced in 18.2.3. HitAction *string `json:"hit_action,omitempty"` // This field indicates that this group is used for learning. Field introduced in 18.2.3. IsLearningGroup *bool `json:"is_learning_group,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Positive Security Model locations. These are used to partition the application name space. Field introduced in 18.2.3. Maximum of 16384 items allowed. Locations []*WafPSMLocation `json:"locations,omitempty"` // If a rule in this group does not match the match_value pattern, this action will be executed. Allowed actions are WAF_ACTION_NO_OP and WAF_ACTION_BLOCK. Enum options - WAF_ACTION_NO_OP, WAF_ACTION_BLOCK, WAF_ACTION_ALLOW_PARAMETER. Field introduced in 18.2.3. MissAction *string `json:"miss_action,omitempty"` // User defined name of the group. Field introduced in 18.2.3. // Required: true Name *string `json:"name"` // Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.3. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of this object. Field introduced in 18.2.3. UUID *string `json:"uuid,omitempty"` }
WafPolicyPSMGroup waf policy p s m group swagger:model WafPolicyPSMGroup
type WafPolicyPSMGroupAPIResponse ¶
type WafPolicyPSMGroupAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*WafPolicyPSMGroup `json:"results,omitempty"` }
WafPolicyPSMGroupAPIResponse waf policy p s m group Api response swagger:model WafPolicyPSMGroupApiResponse
type WafPolicyWhitelist ¶
type WafPolicyWhitelist struct { // Rules to bypass WAF. Field deprecated in 20.1.3. Field introduced in 18.2.3. Maximum of 1024 items allowed. Rules []*WafPolicyWhitelistRule `json:"rules,omitempty"` }
WafPolicyWhitelist waf policy whitelist swagger:model WafPolicyWhitelist
type WafPolicyWhitelistRule ¶
type WafPolicyWhitelistRule struct { // Actions to be performed upon successful matching. Enum options - WAF_POLICY_WHITELIST_ACTION_ALLOW, WAF_POLICY_WHITELIST_ACTION_DETECTION_MODE, WAF_POLICY_WHITELIST_ACTION_CONTINUE. Field deprecated in 20.1.3. Field introduced in 18.2.3. Minimum of 1 items required. Maximum of 1 items allowed. Actions []string `json:"actions,omitempty"` // Description of this rule. Field deprecated in 20.1.3. Field introduced in 18.2.3. Description *string `json:"description,omitempty"` // Enable or disable the rule. Field deprecated in 20.1.3. Field introduced in 18.2.3. Enable *bool `json:"enable,omitempty"` // Rules are executed in order of this index field. Field deprecated in 20.1.3. Field introduced in 18.2.3. // Required: true Index *int32 `json:"index"` // Match criteria describing requests to which this rule should be applied. Field deprecated in 20.1.3. Field introduced in 18.2.3. // Required: true Match *MatchTarget `json:"match"` // A name describing the rule in a short form. Field deprecated in 20.1.3. Field introduced in 18.2.3. // Required: true Name *string `json:"name"` // Percentage of traffic that is sampled. Allowed values are 0-100. Field deprecated in 20.1.3. Field introduced in 20.1.1. Unit is PERCENT. SamplingPercent *int32 `json:"sampling_percent,omitempty"` }
WafPolicyWhitelistRule waf policy whitelist rule swagger:model WafPolicyWhitelistRule
type WafPositiveSecurityModel ¶
type WafPositiveSecurityModel struct { // These groups should be used to separate different levels of concern. The order of the groups matters, one group may mark parts of the request as valid, so that subsequent groups will not check these parts. It is a reference to an object of type WafPolicyPSMGroup. Field introduced in 18.2.3. Maximum of 64 items allowed. GroupRefs []string `json:"group_refs,omitempty"` }
WafPositiveSecurityModel waf positive security model swagger:model WafPositiveSecurityModel
type WafProfile ¶
type WafProfile struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Config params for WAF. Field introduced in 17.2.1. // Required: true Config *WafConfig `json:"config"` // Field introduced in 17.2.1. Description *string `json:"description,omitempty"` // List of Data Files Used for WAF Rules. Field introduced in 17.2.1. Maximum of 64 items allowed. Files []*WafDataFile `json:"files,omitempty"` // Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2. Maximum of 4 items allowed. Labels []*KeyValue `json:"labels,omitempty"` // Field introduced in 17.2.1. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 17.2.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // Field introduced in 17.2.1. UUID *string `json:"uuid,omitempty"` }
WafProfile waf profile swagger:model WafProfile
type WafProfileAPIResponse ¶
type WafProfileAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*WafProfile `json:"results,omitempty"` }
WafProfileAPIResponse waf profile Api response swagger:model WafProfileApiResponse
type WafRule ¶
type WafRule struct { // Enable or disable WAF Rule Group. Field introduced in 17.2.1. // Required: true Enable *bool `json:"enable"` // Exclude list for the WAF rule. The fields in the exclude list entry are logically and'ed to deduce the exclusion criteria. If there are multiple excludelist entries, it will be 'logical or' of them. Field introduced in 17.2.3. Maximum of 64 items allowed. ExcludeList []*WafExcludeListEntry `json:"exclude_list,omitempty"` // When set to 'true', this rule will not cause 'deny' or 'redirect' actions to run, even if WAF Policy is set to enforcement mode. The behavior would be as if this rule operated in detection mode regardless of WAF Policy setting. Field deprecated in 18.1.5. Field introduced in 18.1.4. ForceDetection *bool `json:"force_detection,omitempty"` // Field introduced in 17.2.1. // Required: true Index *int32 `json:"index"` // The rule field is sensitive and will not be displayed. Field introduced in 20.1.1. IsSensitive *bool `json:"is_sensitive,omitempty"` // WAF Rule mode. This can be detection or enforcement. If this is not set, the Policy mode is used. This only takes effect if the policy allows delegation. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT. Field introduced in 18.1.5, 18.2.1. Mode *string `json:"mode,omitempty"` // User-friendly optional name for a rule. Field introduced in 17.2.1. Name *string `json:"name,omitempty"` // The execution phase where this rule will be executed. Enum options - WAF_PHASE_CONNECTION, WAF_PHASE_REQUEST_HEADER, WAF_PHASE_REQUEST_BODY, WAF_PHASE_RESPONSE_HEADER, WAF_PHASE_RESPONSE_BODY, WAF_PHASE_LOGGING. Field introduced in 20.1.1. // Read Only: true Phase *string `json:"phase,omitempty"` // Rule as per Modsec language. Field introduced in 17.2.1. // Required: true Rule *string `json:"rule"` // Identifier (id) for a rule per Modsec language. All SecRule and SecAction directives require an id. It is extracted from the id action in a ModSec rule. Rules within a single WAF Policy are required to have unique rule_ids. Field introduced in 17.2.2. RuleID *string `json:"rule_id,omitempty"` // Tags for WAF rule as per Modsec language. They are extracted from the tag action in a ModSec rule. Field introduced in 18.1.3. Maximum of 64 items allowed. Tags []string `json:"tags,omitempty"` }
WafRule waf rule swagger:model WafRule
type WafRuleGroup ¶
type WafRuleGroup struct { // Enable or disable WAF Rule Group. Field introduced in 17.2.1. // Required: true Enable *bool `json:"enable"` // Exclude list for the WAF rule group. The fields in the exclude list entry are logically and'ed to deduce the exclusion criteria. If there are multiple excludelist entries, it will be 'logical or' of them. Field introduced in 17.2.1. Maximum of 64 items allowed. ExcludeList []*WafExcludeListEntry `json:"exclude_list,omitempty"` // When set to 'true', any rule in this group will not cause 'deny' or 'redirect' actions to run, even if WAF Policy is set to enforcement mode. The behavior would be as if this rule operated in detection mode regardless of WAF Policy setting. Field deprecated in 18.1.5. Field introduced in 18.1.4. ForceDetection *bool `json:"force_detection,omitempty"` // Field introduced in 17.2.1. // Required: true Index *int32 `json:"index"` // Field introduced in 17.2.1. // Required: true Name *string `json:"name"` // Rules as per Modsec language. Field introduced in 17.2.1. Maximum of 1024 items allowed. Rules []*WafRule `json:"rules,omitempty"` }
WafRuleGroup waf rule group swagger:model WafRuleGroup
type WafRuleLog ¶
type WafRuleLog struct { // Transaction data that matched the rule. Field introduced in 17.2.1. Matches []*WafRuleMatchData `json:"matches,omitempty"` // Rule's msg *string per ModSec language. Field introduced in 17.2.1. Msg *string `json:"msg,omitempty"` // Phase in which transaction matched the Rule - for instance, Request Header Phase. Field introduced in 17.2.1. Phase *string `json:"phase,omitempty"` // Rule Group for the matching rule. Field introduced in 17.2.1. RuleGroup *string `json:"rule_group,omitempty"` // ID of the matching rule per ModSec language. Field introduced in 17.2.1. RuleID *int64 `json:"rule_id,omitempty"` // Name of the rule. Field introduced in 17.2.3. RuleName *string `json:"rule_name,omitempty"` // Rule's tags per ModSec language. Field introduced in 17.2.1. Tags []string `json:"tags,omitempty"` }
WafRuleLog waf rule log swagger:model WafRuleLog
type WafRuleMatchData ¶
type WafRuleMatchData struct { // The match_element is an internal variable. It is not possible to add exclusions for this element. Field introduced in 17.2.4. IsInternal *bool `json:"is_internal,omitempty"` // Field from a transaction that matches the rule, for instance if the request parameter is password=foobar, then match_element is ARGS password. Field introduced in 17.2.1. MatchElement *string `json:"match_element,omitempty"` // Value for a field from a transaction that matches the rule, for instance if the request parameter is password=foobar, then match_value is foobar. Field introduced in 17.2.1. MatchValue *string `json:"match_value,omitempty"` }
WafRuleMatchData waf rule match data swagger:model WafRuleMatchData
type WafWhitelistLog ¶
type WafWhitelistLog struct { // Actions generated by this rule. Enum options - WAF_POLICY_WHITELIST_ACTION_ALLOW, WAF_POLICY_WHITELIST_ACTION_DETECTION_MODE, WAF_POLICY_WHITELIST_ACTION_CONTINUE. Field deprecated in 20.1.3. Field introduced in 18.2.3. Actions []string `json:"actions,omitempty"` // Name of the matched rule. Field deprecated in 20.1.3. Field introduced in 18.2.3. RuleName *string `json:"rule_name,omitempty"` }
WafWhitelistLog waf whitelist log swagger:model WafWhitelistLog
type WebApplicationSignatureServiceStatus ¶
type WebApplicationSignatureServiceStatus struct { // If the last attempted update failed, this is a more detailed error message. Field introduced in 20.1.3. Error *string `json:"error,omitempty"` // The time when the Application Signature service last successfull attemped to update this object. It will be not update, if an error occurs during an update attempt. In this case, the errror will be set. Field introduced in 20.1.3. LastSuccessfulUpdateCheck *TimeStamp `json:"last_successful_update_check,omitempty"` }
WebApplicationSignatureServiceStatus web application signature service status swagger:model WebApplicationSignatureServiceStatus
type Webhook ¶
type Webhook struct { // UNIX time since epoch in microseconds. Units(MICROSECONDS). // Read Only: true LastModified *string `json:"_last_modified,omitempty"` // Callback URL for the Webhook. Field introduced in 17.1.1. CallbackURL *string `json:"callback_url,omitempty"` // Field introduced in 17.1.1. Description *string `json:"description,omitempty"` // The name of the webhook profile. Field introduced in 17.1.1. // Required: true Name *string `json:"name"` // It is a reference to an object of type Tenant. Field introduced in 17.1.1. TenantRef *string `json:"tenant_ref,omitempty"` // url // Read Only: true URL *string `json:"url,omitempty"` // UUID of the webhook profile. Field introduced in 17.1.1. UUID *string `json:"uuid,omitempty"` // Verification token sent back with the callback asquery parameters. Field introduced in 17.1.1. VerificationToken *string `json:"verification_token,omitempty"` }
Webhook webhook swagger:model Webhook
type WebhookAPIResponse ¶
type WebhookAPIResponse struct { // count // Required: true Count *int32 `json:"count"` // next Next *string `json:"next,omitempty"` // results // Required: true Results []*Webhook `json:"results,omitempty"` }
WebhookAPIResponse webhook Api response swagger:model WebhookApiResponse
Source Files
¶
- a_c_subject_info.go
- a_c_user_identity.go
- a_l_b_services_account.go
- a_l_b_services_account_user.go
- a_l_b_services_case.go
- a_l_b_services_case_attachment.go
- a_l_b_services_config.go
- a_l_b_services_config_api_response.go
- a_l_b_services_file_upload.go
- a_l_b_services_file_upload_api_response.go
- a_l_b_services_status_details.go
- a_l_b_services_user.go
- a_w_s_a_s_g_delete.go
- a_w_s_a_s_g_notif_details.go
- a_w_s_login.go
- a_w_s_setup.go
- ab_pool.go
- action_group_config.go
- action_group_config_api_response.go
- admin_auth_configuration.go
- alert.go
- alert_api_response.go
- alert_config.go
- alert_config_api_response.go
- alert_email_config.go
- alert_email_config_api_response.go
- alert_filter.go
- alert_metric_threshold.go
- alert_mgr_debug_filter.go
- alert_object_list.go
- alert_object_list_api_response.go
- alert_rule.go
- alert_rule_event.go
- alert_rule_metric.go
- alert_script_config.go
- alert_script_config_api_response.go
- alert_syslog_config.go
- alert_syslog_config_api_response.go
- alert_syslog_server.go
- alert_test_email_params.go
- alert_test_syslog_snmp_params.go
- all_se_upgrade_event_details.go
- analytics_policy.go
- analytics_profile.go
- analytics_profile_api_response.go
- anomaly_event_details.go
- api_c_configuration.go
- api_c_lifs_runtime.go
- api_c_lifs_runtime_api_response.go
- api_c_network_rel.go
- api_version_deprecated.go
- apic_agent_bridge_domain_vrf_change.go
- apic_agent_generic_event_details.go
- apic_agent_vs_network_error.go
- apic_v_s_placement_req.go
- app_cookie_persistence_profile.go
- app_hdr.go
- app_info.go
- app_learning_confidence_override.go
- app_learning_params.go
- app_signature_config.go
- app_signature_event_data.go
- application.go
- application_api_response.go
- application_log.go
- application_persistence_profile.go
- application_persistence_profile_api_response.go
- application_profile.go
- application_profile_api_response.go
- arp_table_filter.go
- attack_meta_data.go
- attack_meta_data_api_response.go
- attack_mitigation_action.go
- audit_compliance_event_info.go
- auth_attribute_match.go
- auth_mapping_rule.go
- auth_match_attribute.go
- auth_match_group_membership.go
- auth_profile.go
- auth_profile_api_response.go
- auth_profile_http_client_params.go
- auth_tacacs_plus_attribute_value_pair.go
- authentication_action.go
- authentication_match.go
- authentication_policy.go
- authentication_rule.go
- authn_rule_match.go
- authorization_action.go
- authorization_match.go
- authorization_policy.go
- authorization_rule.go
- authz_rule_match.go
- auto_scale_launch_config.go
- auto_scale_launch_config_api_response.go
- auto_scale_mesos_settings.go
- auto_scale_mgr_debug_filter.go
- auto_scale_open_stack_settings.go
- availability_zone.go
- availability_zone_api_response.go
- avg_uptime_change_details.go
- aws_configuration.go
- aws_encryption.go
- aws_zone_config.go
- aws_zone_network.go
- azure_cluster_info.go
- azure_configuration.go
- azure_info.go
- azure_marketplace.go
- azure_network_info.go
- azure_service_principal_credentials.go
- azure_setup.go
- azure_user_pass_credentials.go
- b_m_setup.go
- backup.go
- backup_api_response.go
- backup_configuration.go
- backup_configuration_api_response.go
- bfd_profile.go
- bgp_peer.go
- bgp_profile.go
- bgp_routing_options.go
- bot_allow_list.go
- bot_allow_rule.go
- bot_class_matcher.go
- bot_classification.go
- bot_config_consolidator.go
- bot_config_consolidator_api_response.go
- bot_config_ip_location.go
- bot_config_ip_reputation.go
- bot_config_user_agent.go
- bot_detection_match.go
- bot_detection_policy.go
- bot_detection_policy_api_response.go
- bot_evaluation_result.go
- bot_identification.go
- bot_management_log.go
- bot_mapping.go
- bot_mapping_api_response.go
- bot_mapping_rule.go
- bot_type_matcher.go
- build_info.go
- burst_license_details.go
- c_c_agent_properties.go
- c_c_properties.go
- c_c_scale_set_notif_details.go
- c_c_vnic_info.go
- c_r_l.go
- c_r_s_deployment_failure.go
- c_r_s_deployment_success.go
- c_r_s_details.go
- c_r_s_details_api_response.go
- c_r_s_update_details.go
- capture_file_size.go
- capture_filters.go
- capture_ip_c.go
- cdp_lldp_info.go
- certificate_authority.go
- certificate_management_profile.go
- certificate_management_profile_api_response.go
- cfg_state.go
- child_process_info.go
- cif.go
- client_insights_sampling.go
- client_log_configuration.go
- client_log_filter.go
- client_log_streaming_config.go
- client_log_streaming_format.go
- clone_server.go
- cloud.go
- cloud_a_s_g_notif_details.go
- cloud_api_response.go
- cloud_autoscaling_config_failure_details.go
- cloud_cluster_vip.go
- cloud_connector_debug_filter.go
- cloud_connector_user.go
- cloud_connector_user_api_response.go
- cloud_connector_user_test_params.go
- cloud_dns_update.go
- cloud_flavor.go
- cloud_generic.go
- cloud_health.go
- cloud_info.go
- cloud_ip_change.go
- cloud_meta.go
- cloud_properties.go
- cloud_properties_api_response.go
- cloud_route_notif_details.go
- cloud_runtime.go
- cloud_runtime_api_response.go
- cloud_se_vm_change.go
- cloud_stack_configuration.go
- cloud_stack_setup.go
- cloud_sync_services.go
- cloud_tenant_cleanup.go
- cloud_tenants_deleted.go
- cloud_vip_parking_intf.go
- cloud_vip_update.go
- cloud_vnic_change.go
- cluster_cloud_details.go
- cluster_cloud_details_api_response.go
- cluster_config_failed_event.go
- cluster_leader_failover_event.go
- cluster_node.go
- cluster_node_add_event.go
- cluster_node_db_failed_event.go
- cluster_node_remove_event.go
- cluster_node_shutdown_event.go
- cluster_node_started_event.go
- cluster_service_critical_failure_event.go
- cluster_service_failed_event.go
- cluster_service_restored_event.go
- cluster_warm_reboot_event.go
- compression_filter.go
- compression_profile.go
- config_action_details.go
- config_create_details.go
- config_delete_details.go
- config_info.go
- config_se_grp_flv_update.go
- config_update_details.go
- config_user_authrz_by_rule.go
- config_user_login.go
- config_user_logout.go
- config_user_not_authrz_by_rule.go
- config_user_password_change_request.go
- conn_error_info.go
- conn_pool_properties.go
- connection_clear_filter.go
- connection_log.go
- connpool_filter.go
- container_cloud_batch_setup.go
- container_cloud_service.go
- container_cloud_setup.go
- content_lib_config.go
- content_rewrite_profile.go
- controller_cloud_limits.go
- controller_discontinuous_time_change_event_details.go
- controller_license_reconcile_details.go
- controller_limits.go
- controller_portal_asset.go
- controller_portal_auth.go
- controller_portal_registration.go
- controller_portal_registration_api_response.go
- controller_properties.go
- controller_properties_api_response.go
- controller_site.go
- controller_site_api_response.go
- controller_size.go
- controller_sizing_cloud_limits.go
- controller_sizing_limits.go
- controller_upgrade_state.go
- cookie_match.go
- custom_ip_a_m_dns_profile.go
- custom_ip_a_m_dns_profile_api_response.go
- custom_params.go
- custom_tag.go
- d_s_request_log.go
- data_script_error_trace.go
- database_event_info.go
- db_app_learning_info.go
- debug_controller.go
- debug_controller_api_response.go
- debug_dns_options.go
- debug_filter_union.go
- debug_ip_addr.go
- debug_se_agent.go
- debug_se_cpu_shares.go
- debug_se_dataplane.go
- debug_se_fault.go
- debug_service_engine.go
- debug_service_engine_api_response.go
- debug_virtual_service.go
- debug_virtual_service_api_response.go
- debug_virtual_service_capture.go
- debug_virtual_service_obj_sync.go
- debug_virtual_service_se_params.go
- debug_vrf.go
- debug_vrf_context.go
- debug_vs_dataplane.go
- disable_se_migrate_event_details.go
- discovered_network.go
- dispatcher_table_dump_clear.go
- dns_a_a_a_a_rdata.go
- dns_a_rdata.go
- dns_attack.go
- dns_attacks.go
- dns_client_ip_match.go
- dns_cname_rdata.go
- dns_config.go
- dns_configuration.go
- dns_edns_option.go
- dns_geo_location_match.go
- dns_info.go
- dns_mx_rdata.go
- dns_ns_rdata.go
- dns_opt_record.go
- dns_policies.go
- dns_policy.go
- dns_policy_api_response.go
- dns_query_name_match.go
- dns_query_type_match.go
- dns_rate_limiter.go
- dns_rate_profile.go
- dns_record.go
- dns_register_info.go
- dns_request.go
- dns_resource_record.go
- dns_response.go
- dns_rr_set.go
- dns_rule.go
- dns_rule_action.go
- dns_rule_action_allow_drop.go
- dns_rule_action_gslb_site_selection.go
- dns_rule_action_pool_switching.go
- dns_rule_action_response.go
- dns_rule_dns_rr_set.go
- dns_rule_match_target.go
- dns_rule_r_l_action.go
- dns_service_application_profile.go
- dns_service_domain.go
- dns_srv_rdata.go
- dns_transport_protocol_match.go
- dns_txt_rdata.go
- dns_vs_sync_info.go
- dns_zone.go
- docker_configuration.go
- docker_registry.go
- docker_u_c_p_setup.go
- dos_attack_event_details.go
- dos_rate_limit_profile.go
- dos_threshold.go
- dos_threshold_profile.go
- dsr_profile.go
- dynamic_dns_record.go
- dynamic_dns_record_api_response.go
- email_configuration.go
- equivalent_labels.go
- error_page.go
- error_page_body.go
- error_page_body_api_response.go
- error_page_profile.go
- error_page_profile_api_response.go
- event_cache.go
- event_details.go
- event_details_filter.go
- event_gen_params.go
- event_log.go
- event_map.go
- fail_action.go
- fail_action_backup_pool.go
- fail_action_http_local_response.go
- fail_action_http_redirect.go
- fe_proxy_route_publish_config.go
- federation_checkpoint.go
- federation_checkpoint_api_response.go
- file_object.go
- file_object_api_response.go
- floating_ip_subnet.go
- flowtable_profile.go
- full_client_logs.go
- g_c_p_cloud_router_update.go
- g_c_p_configuration.go
- g_c_p_credentials.go
- g_c_p_encryption_keys.go
- g_c_p_in_band_management.go
- g_c_p_network_config.go
- g_c_p_one_arm_mode.go
- g_c_p_se_group_config.go
- g_c_p_setup.go
- g_c_p_two_arm_mode.go
- g_c_p_v_ip_allocation.go
- g_c_p_v_ip_i_l_b.go
- g_c_p_v_ip_routes.go
- gateway_monitor.go
- gcp_info.go
- geo_d_b.go
- geo_d_b_api_response.go
- geo_d_b_file.go
- geo_d_b_mapping.go
- geo_d_b_mapping_element.go
- geo_location.go
- geo_match.go
- gslb.go
- gslb_api_response.go
- gslb_client_ip_addr_group.go
- gslb_dns_geo_update.go
- gslb_dns_gs_status.go
- gslb_dns_info.go
- gslb_dns_se_info.go
- gslb_dns_update.go
- gslb_download_status.go
- gslb_geo_db_entry.go
- gslb_geo_db_file.go
- gslb_geo_db_profile.go
- gslb_geo_db_profile_api_response.go
- gslb_geo_location.go
- gslb_health_monitor_proxy.go
- gslb_ip_addr.go
- gslb_obj.go
- gslb_object_info.go
- gslb_per_dns_state.go
- gslb_pool.go
- gslb_pool_member.go
- gslb_pool_member_datapath_status.go
- gslb_pool_member_runtime_info.go
- gslb_pool_runtime.go
- gslb_replication_stats.go
- gslb_runtime.go
- gslb_service.go
- gslb_service_api_response.go
- gslb_service_down_response.go
- gslb_service_runtime.go
- gslb_service_site_persistence_pool.go
- gslb_service_status.go
- gslb_site.go
- gslb_site_cfg_sync_info.go
- gslb_site_dns_vs.go
- gslb_site_health_status.go
- gslb_site_runtime.go
- gslb_site_runtime_cfg.go
- gslb_site_runtime_info.go
- gslb_site_runtime_stats.go
- gslb_status.go
- gslb_sub_domain_placement_runtime.go
- gslb_third_party_site.go
- gslb_third_party_site_runtime.go
- h_s_m_aws_cloud_hsm.go
- h_s_m_safenet_client_info.go
- h_s_m_safenet_luna.go
- h_s_m_safenet_luna_server.go
- h_s_m_thales_net_hsm.go
- h_s_m_thales_r_f_s.go
- h_s_mgr_debug_filter.go
- hardware_security_module.go
- hardware_security_module_group.go
- hardware_security_module_group_api_response.go
- hdr_match.go
- hdr_persistence_profile.go
- health_monitor.go
- health_monitor_api_response.go
- health_monitor_auth_info.go
- health_monitor_dns.go
- health_monitor_external.go
- health_monitor_http.go
- health_monitor_imap.go
- health_monitor_pop3.go
- health_monitor_radius.go
- health_monitor_s_ip.go
- health_monitor_s_slattributes.go
- health_monitor_smtp.go
- health_monitor_tcp.go
- health_monitor_udp.go
- health_score_details.go
- host_attributes.go
- host_hdr_match.go
- host_unavail_event_details.go
- http2_application_profile.go
- http_application_profile.go
- http_cache_config.go
- http_cache_obj_filter.go
- http_client_authentication_params.go
- http_cookie_data.go
- http_cookie_persistence_key.go
- http_cookie_persistence_profile.go
- http_hdr_action.go
- http_hdr_data.go
- http_hdr_value.go
- http_local_file.go
- http_policies.go
- http_policy_set.go
- http_policy_set_api_response.go
- http_redirect_action.go
- http_request_policy.go
- http_request_rule.go
- http_reselect_resp_code.go
- http_response_policy.go
- http_response_rule.go
- http_rewrite_loc_hdr_action.go
- http_rewrite_url_action.go
- http_version_match.go
- httpsecurity_action.go
- httpsecurity_action_rate_profile.go
- httpsecurity_policy.go
- httpsecurity_rule.go
- httpserver_reselect.go
- httpstatus_match.go
- httpstatus_range.go
- httpswitching_action.go
- hypervisor_properties.go
- icap_log.go
- icap_profile.go
- icap_profile_api_response.go
- icap_request_log.go
- icap_violation.go
- image.go
- image_api_response.go
- image_cloud_data.go
- image_cloud_specific_data.go
- infoblox_subnet.go
- ing_attribute.go
- internal_gateway_monitor.go
- ip_a_m_dns_aws_profile.go
- ip_a_m_dns_azure_profile.go
- ip_a_m_dns_custom_profile.go
- ip_a_m_dns_g_c_p_profile.go
- ip_a_m_dns_infoblox_profile.go
- ip_a_m_dns_internal_profile.go
- ip_a_m_dns_o_c_iprofile.go
- ip_a_m_dns_openstack_profile.go
- ip_a_m_dns_provider_profile.go
- ip_a_m_dns_provider_profile_api_response.go
- ip_a_m_dns_tencent_profile.go
- ip_a_m_usable_network.go
- ip_addr.go
- ip_addr_group.go
- ip_addr_group_api_response.go
- ip_addr_match.go
- ip_addr_port.go
- ip_addr_prefix.go
- ip_addr_range.go
- ip_alloc_info.go
- ip_community.go
- ip_network_subnet.go
- ip_persistence_profile.go
- ip_reputation_config.go
- ip_reputation_d_b.go
- ip_reputation_d_b_api_response.go
- ip_reputation_service_status.go
- ip_reputation_type_mapping.go
- ip_reputation_type_match.go
- ip_threat_d_b_event_data.go
- iptable_rule.go
- iptable_rule_set.go
- j_w_t_claim_match.go
- j_w_t_match.go
- j_w_t_server_profile.go
- j_w_t_server_profile_api_response.go
- j_w_t_validation_vs_config.go
- job_entry.go
- job_entry_api_response.go
- jwt_log.go
- key_value.go
- key_value_tuple.go
- l4_connection_policy.go
- l4_policies.go
- l4_policy_set.go
- l4_policy_set_api_response.go
- l4_rule.go
- l4_rule_action.go
- l4_rule_action_select_pool.go
- l4_rule_match_target.go
- l4_rule_port_match.go
- l4_rule_protocol_match.go
- ldap_auth_settings.go
- ldap_directory_settings.go
- ldap_user_bind_settings.go
- learning_log_policy.go
- license_details.go
- license_expiry_details.go
- license_info.go
- license_ledger_details.go
- license_ledger_details_api_response.go
- license_tier_switch_detiails.go
- license_tier_usage.go
- license_transaction_details.go
- license_usage.go
- lif.go
- linux_configuration.go
- linux_server_configuration.go
- linux_server_host.go
- location_hdr_match.go
- log_agent_event_detail.go
- log_agent_tcp_client_event_detail.go
- log_controller_mapping.go
- log_controller_mapping_api_response.go
- marathon_configuration.go
- marathon_se_deployment.go
- marathon_service_port_conflict.go
- match_replace_pair.go
- match_target.go
- member_interface.go
- memory_balancer_info.go
- mesos_attribute.go
- mesos_configuration.go
- mesos_metrics_debug_filter.go
- mesos_se_resources.go
- mesos_setup.go
- method_match.go
- metric_log.go
- metric_statistics.go
- metric_thresold_up_details.go
- metrics_api_srv_debug_filter.go
- metrics_data.go
- metrics_data_header.go
- metrics_data_series.go
- metrics_db_disk_event_details.go
- metrics_db_queue_full_event_details.go
- metrics_db_queue_healthy_event_details.go
- metrics_db_runtime.go
- metrics_derivation_data.go
- metrics_dimension_data.go
- metrics_event_threshold.go
- metrics_mgr_debug_filter.go
- metrics_missing_data_interval.go
- metrics_query_response.go
- metrics_real_time_update.go
- mgmt_ip_access_control.go
- micro_service.go
- micro_service_api_response.go
- micro_service_container.go
- micro_service_group.go
- micro_service_group_api_response.go
- micro_service_match.go
- n_t_p_authentication_key.go
- n_t_p_configuration.go
- n_t_p_server.go
- nat_addr_info.go
- nat_match_target.go
- nat_policy.go
- nat_policy_action.go
- nat_policy_api_response.go
- nat_rule.go
- network.go
- network_api_response.go
- network_filter.go
- network_profile.go
- network_profile_api_response.go
- network_profile_union.go
- network_runtime.go
- network_runtime_api_response.go
- network_security_match_target.go
- network_security_policy.go
- network_security_policy_action_r_l_param.go
- network_security_policy_api_response.go
- network_security_rule.go
- network_service.go
- network_service_api_response.go
- network_subnet_clash.go
- network_subnet_info.go
- nsx_configuration.go
- nsxt_configuration.go
- nsxt_credentials.go
- nsxt_datastores.go
- nsxt_hosts.go
- nsxt_image_details.go
- nsxt_segment_runtime.go
- nsxt_segment_runtime_api_response.go
- nsxt_setup.go
- nsxt_tier1_segment_automatic_mode.go
- nsxt_tier1_segment_config.go
- nsxt_tier1_segment_manual_mode.go
- ntlm_log.go
- nuage_s_d_n_controller.go
- o_c_i_credentials.go
- o_c_i_setup.go
- o_c_s_p_config.go
- o_c_s_p_response_info.go
- o_shift_k8_s_configuration.go
- obj_sync_config.go
- open_stack_api_version_check_failure.go
- open_stack_cluster_setup.go
- open_stack_configuration.go
- open_stack_hypervisor_properties.go
- open_stack_ip_change.go
- open_stack_lb_plugin_op.go
- open_stack_lb_prov_audit_check.go
- open_stack_role_mapping.go
- open_stack_se_vm_change.go
- open_stack_sync_services.go
- open_stack_vip_network.go
- open_stack_vnic_change.go
- openstack_login.go
- operational_status.go
- ops_history.go
- oshift_docker_registry_meta_data.go
- oshift_shared_virtual_service.go
- out_of_band_request_log.go
- p_g_deployment_rule.go
- p_g_deployment_rule_result.go
- p_k_iprofile.go
- p_k_iprofile_api_response.go
- paa_log.go
- paa_request_log.go
- package_details.go
- param_info.go
- param_size_class.go
- param_type_class.go
- patch_data.go
- patch_info.go
- path_match.go
- performance_limits.go
- permission.go
- persistence_filter.go
- ping_access_agent.go
- ping_access_agent_api_response.go
- placement_network.go
- placement_scope_config.go
- pod_toleration.go
- pool.go
- pool_analytics_policy.go
- pool_api_response.go
- pool_deployment_failure_info.go
- pool_deployment_success_info.go
- pool_deployment_update_info.go
- pool_group.go
- pool_group_api_response.go
- pool_group_deployment_policy.go
- pool_group_deployment_policy_api_response.go
- pool_group_member.go
- pool_server.go
- port_match.go
- port_match_generic.go
- port_range.go
- portal_configuration.go
- portal_feature_opt_in.go
- priority_labels.go
- priority_labels_api_response.go
- proactive_support_defaults.go
- property.go
- protocol_match.go
- protocol_parser.go
- protocol_parser_api_response.go
- proxy_configuration.go
- psm_program_details.go
- query_match.go
- rancher_configuration.go
- rate_limiter.go
- rate_limiter_action.go
- rate_limiter_event_details.go
- rate_limiter_profile.go
- rate_limiter_properties.go
- rate_profile.go
- rebalance_migrate_event_details.go
- rebalance_scalein_event_details.go
- rebalance_scaleout_event_details.go
- reboot_data.go
- rediscover_vcenter_param.go
- replace_string_var.go
- replication_policy.go
- response_match_target.go
- retry_placement_params.go
- rm_add_networks_event_details.go
- rm_add_vnic.go
- rm_bind_vs_se_event_details.go
- rm_delete_se_event_details.go
- rm_modify_networks_event_details.go
- rm_modify_vnic.go
- rm_reboot_se_event_details.go
- rm_se_bootup_fail_event_details.go
- rm_se_ip_fail_event_details.go
- rm_spawn_se_event_details.go
- rm_unbind_vs_se_event_details.go
- role.go
- role_api_response.go
- role_filter.go
- role_filter_match_label.go
- route_info.go
- routing_service.go
- s_a_m_l_s_p_config.go
- s_c_pool_server_state_info.go
- s_c_pool_server_state_info_api_response.go
- s_c_server_state_info.go
- s_c_vs_state_info.go
- s_c_vs_state_info_api_response.go
- s_e_fault_inject_exhaust_param.go
- s_e_fault_inject_se_param.go
- s_s_l_cache_filter.go
- s_s_l_certificate.go
- s_s_l_certificate_description.go
- s_s_l_cipher_list.go
- s_s_l_client_certificate_action.go
- s_s_l_client_request_header.go
- s_s_l_expire_details.go
- s_s_l_export_details.go
- s_s_l_ignored_details.go
- s_s_l_key_and_certificate.go
- s_s_l_key_and_certificate_api_response.go
- s_s_l_key_e_c_params.go
- s_s_l_key_params.go
- s_s_l_key_r_s_a_params.go
- s_s_l_profile.go
- s_s_l_profile_api_response.go
- s_s_l_profile_selector.go
- s_s_l_rating.go
- s_s_l_renew_details.go
- s_s_l_renew_failed_details.go
- s_s_l_revoked_details.go
- s_s_l_version.go
- s_s_o_policy.go
- s_s_o_policy_api_response.go
- saml_attribute.go
- saml_authn_rule_match.go
- saml_authz_rule_match.go
- saml_identity_provider_settings.go
- saml_log.go
- saml_service_provider_node.go
- saml_service_provider_settings.go
- saml_settings.go
- scale_status.go
- scheduler.go
- scheduler_action_details.go
- scheduler_api_response.go
- se_agent_properties.go
- se_agent_state_cache_properties.go
- se_bgp_peer_down_details.go
- se_bgp_peer_state_change_details.go
- se_bootup_compression_properties.go
- se_bootup_properties.go
- se_discontinuous_time_change_event_details.go
- se_dupip_event_details.go
- se_fault.go
- se_gateway_heartbeat_failed_details.go
- se_gateway_heartbeat_success_details.go
- se_geo_db_details.go
- se_group_analytics_policy.go
- se_group_options.go
- se_group_resume_options.go
- se_group_status.go
- se_h_b_event_details.go
- se_hb_recovered_event_details.go
- se_hm_event_g_s_details.go
- se_hm_event_gslb_pool_details.go
- se_hm_event_gslb_pool_member_details.go
- se_hm_event_pool_details.go
- se_hm_event_server_details.go
- se_hm_event_shm_details.go
- se_hm_event_vs_details.go
- se_ip6_dad_failed_event_details.go
- se_ip_added_event_details.go
- se_ip_removed_event_details.go
- se_ipfailure_event_details.go
- se_licensed_bandwdith_exceeded_event_details.go
- se_list.go
- se_memory_limit_event_details.go
- se_mgr_debug_filter.go
- se_mgr_event_details.go
- se_migrate_event_details.go
- se_persistence_event_details.go
- se_pool_lb_event_details.go
- se_properties.go
- se_properties_api_response.go
- se_rate_limiters.go
- se_reconcile_details.go
- se_resources.go
- se_rpc_proxy_debug_filter.go
- se_runtime_compression_properties.go
- se_runtime_properties.go
- se_thresh_event_details.go
- se_upgrade_event_details.go
- se_upgrade_events.go
- se_upgrade_migrate_event_details.go
- se_upgrade_params.go
- se_upgrade_scalein_event_details.go
- se_upgrade_scaleout_event_details.go
- se_upgrade_status_summary.go
- se_upgrade_vs_disrupted_event_details.go
- se_version_check_failed_event.go
- se_vip_interface_list.go
- se_vnic_down_event_details.go
- se_vnic_tx_queue_stall_event_details.go
- se_vnic_up_event_details.go
- se_vs_fault_event_details.go
- se_vs_pkt_buf_high_event_details.go
- sec_mgr_data_event.go
- sec_mgr_threshold.go
- secure_channel_available_local_ips.go
- secure_channel_available_local_ips_api_response.go
- secure_channel_configuration.go
- secure_channel_mapping.go
- secure_channel_mapping_api_response.go
- secure_channel_metadata.go
- secure_channel_token.go
- secure_channel_token_api_response.go
- secure_key_exchange_details.go
- security_manager_data.go
- security_manager_data_api_response.go
- security_mgr_debug_filter.go
- security_mgr_runtime.go
- security_policy.go
- security_policy_api_response.go
- selector.go
- sensitive_field_rule.go
- sensitive_log_profile.go
- server.go
- server_auto_scale_failed_info.go
- server_auto_scale_in_complete_info.go
- server_auto_scale_in_info.go
- server_auto_scale_out_complete_info.go
- server_auto_scale_out_info.go
- server_auto_scale_policy.go
- server_auto_scale_policy_api_response.go
- server_config.go
- server_id.go
- server_scale_in_params.go
- server_scale_out_params.go
- service.go
- service_engine.go
- service_engine_api_response.go
- service_engine_cloud_limits.go
- service_engine_group.go
- service_engine_group_api_response.go
- service_engine_limits.go
- service_match.go
- service_pool_selector.go
- sideband_profile.go
- sip_log.go
- sip_message.go
- sip_service_application_profile.go
- site_version.go
- site_version_api_response.go
- snmp_configuration.go
- snmp_trap_profile.go
- snmp_trap_profile_api_response.go
- snmp_trap_server.go
- snmp_v3_configuration.go
- snmp_v3_user_params.go
- ssh_se_deployment.go
- state_cache_mgr_debug_filter.go
- static_ip_alloc_info.go
- static_ip_range.go
- static_ip_range_runtime.go
- static_route.go
- streaming_syslog_config.go
- string_group.go
- string_group_api_response.go
- string_match.go
- sub_job.go
- subnet.go
- subnet_runtime.go
- summarized_info.go
- summarized_subnet_info.go
- supported_migrations.go
- switchover_event_details.go
- switchover_fail_event_details.go
- sys_test_email_params.go
- system_configuration.go
- system_configuration_api_response.go
- system_limits.go
- system_limits_api_response.go
- system_upgrade_details.go
- system_upgrade_state.go
- tacacs_plus_auth_settings.go
- tag.go
- tcp_application_profile.go
- tcp_attacks.go
- tcp_fast_path_profile.go
- tcp_proxy_profile.go
- tenant.go
- tenant_api_response.go
- tenant_configuration.go
- tenant_label.go
- tencent_credentials.go
- tencent_setup.go
- tencent_zone_network.go
- test_se_datastore_level1.go
- test_se_datastore_level1_api_response.go
- test_se_datastore_level2.go
- test_se_datastore_level2_api_response.go
- test_se_datastore_level3.go
- test_se_datastore_level3_api_response.go
- tier1_logical_router_info.go
- time_stamp.go
- tls_ticket.go
- traffic_clone_profile.go
- traffic_clone_profile_api_response.go
- udp_attacks.go
- udp_fast_path_profile.go
- udp_proxy_profile.go
- upgrade_event.go
- upgrade_ops_entry.go
- upgrade_ops_param.go
- upgrade_ops_state.go
- upgrade_status_info.go
- upgrade_status_info_api_response.go
- upgrade_status_summary.go
- upgrade_status_summary_api_response.go
- upgrade_task.go
- uri_info.go
- uri_param.go
- uri_param_query.go
- uri_param_token.go
- user.go
- user_account_profile.go
- user_account_profile_api_response.go
- user_activity.go
- user_activity_api_response.go
- user_api_response.go
- user_role.go
- v_c_a_setup.go
- v_center_configuration.go
- v_center_credentials.go
- v_center_server.go
- v_center_server_api_response.go
- v_cloud_air_configuration.go
- v_h_match.go
- v_i_admin_credentials.go
- v_i_controller_vnic_info.go
- v_i_create_s_e_req.go
- v_i_fault_injection.go
- v_i_guestv_nic_ip_addr.go
- v_i_mgr_cluster_runtime.go
- v_i_mgr_cluster_runtime_api_response.go
- v_i_mgr_controller_runtime.go
- v_i_mgr_controller_runtime_api_response.go
- v_i_mgr_d_c_runtime.go
- v_i_mgr_d_c_runtime_api_response.go
- v_i_mgr_guest_nic_runtime.go
- v_i_mgr_host_runtime.go
- v_i_mgr_host_runtime_api_response.go
- v_i_mgr_interested_entity.go
- v_i_mgr_ip_subnet_runtime.go
- v_i_mgr_n_w_runtime.go
- v_i_mgr_n_w_runtime_api_response.go
- v_i_mgr_s_e_vm_runtime.go
- v_i_mgr_s_e_vm_runtime_api_response.go
- v_i_mgr_vcenter_runtime.go
- v_i_mgr_vcenter_runtime_api_response.go
- v_i_mgr_vm_runtime.go
- v_i_mgr_vm_runtime_api_response.go
- v_i_retrieve_p_g_names.go
- v_i_se_vm_ip_conf_params.go
- v_i_se_vm_ova_params.go
- v_i_set_mgmt_ip_s_e_req.go
- v_i_setv_nic_nw_req.go
- v_i_vm_vnic_info.go
- v_id_c_info.go
- v_id_c_info_api_response.go
- v_idelete_network_filter.go
- v_idelete_s_e_req.go
- v_ip_g_name_info.go
- v_ip_g_name_info_api_response.go
- v_n_i_c.go
- v_n_i_c_network.go
- v_s_data_script.go
- v_s_data_script_set.go
- v_s_data_script_set_api_response.go
- v_s_data_scripts.go
- vcenter_cloud_status_req.go
- vcenter_clusters.go
- vcenter_datastore.go
- vcenter_hosts.go
- vcenter_inventory_diag_req.go
- vcenter_login.go
- version_info.go
- vinfra_cntlr_host_unreachable_list.go
- vinfra_disc_summary_details.go
- vinfra_mgmt_nw_change_details.go
- vinfra_pool_server_delete_details.go
- vinfra_vcenter_bad_credentials.go
- vinfra_vcenter_connectivity_status.go
- vinfra_vcenter_discovery_failure.go
- vinfra_vcenter_network_limit.go
- vinfra_vcenter_obj_delete_details.go
- vinfra_vm_details.go
- vip.go
- vip_autoscale_configuration.go
- vip_autoscale_group.go
- vip_autoscale_policy.go
- vip_autoscale_zones.go
- vip_placement_network.go
- vip_placement_resolution_info.go
- vip_runtime.go
- vip_scale_details.go
- vip_se_assigned.go
- virtual_service.go
- virtual_service_api_response.go
- virtual_service_resource.go
- virtual_service_runtime.go
- vlan_interface.go
- vlan_range.go
- vrf_context.go
- vrf_context_api_response.go
- vs_apic_extension.go
- vs_awaiting_se_event_details.go
- vs_debug_filter.go
- vs_error.go
- vs_error_event_details.go
- vs_ev_status.go
- vs_fsm_event_details.go
- vs_initial_placement_event_details.go
- vs_migrate_event_details.go
- vs_migrate_params.go
- vs_pool_nw_filter_event_details.go
- vs_resync_params.go
- vs_scale_in_event_details.go
- vs_scale_out_event_details.go
- vs_scalein_params.go
- vs_scaleout_params.go
- vs_se_vnic.go
- vs_switchover_params.go
- vs_vip.go
- vs_vip_api_response.go
- vserver_l4_metrics_obj.go
- vserver_l7_metrics_obj.go
- vss_placement.go
- waf_allowlist_log.go
- waf_application_signature_app_version.go
- waf_application_signature_provider.go
- waf_application_signature_provider_api_response.go
- waf_application_signatures.go
- waf_c_r_s.go
- waf_c_r_s_api_response.go
- waf_config.go
- waf_data_file.go
- waf_exclude_list_entry.go
- waf_exclusion_type.go
- waf_learning.go
- waf_log.go
- waf_p_s_m_location.go
- waf_p_s_m_location_match.go
- waf_p_s_m_log.go
- waf_p_s_m_match_element.go
- waf_p_s_m_rule.go
- waf_policy.go
- waf_policy_allowlist.go
- waf_policy_allowlist_rule.go
- waf_policy_api_response.go
- waf_policy_p_s_m_group.go
- waf_policy_p_s_m_group_api_response.go
- waf_policy_whitelist.go
- waf_policy_whitelist_rule.go
- waf_positive_security_model.go
- waf_profile.go
- waf_profile_api_response.go
- waf_rule.go
- waf_rule_group.go
- waf_rule_log.go
- waf_rule_match_data.go
- waf_whitelist_log.go
- web_application_signature_service_status.go
- webhook.go
- webhook_api_response.go