--- title: GlobalSettings slug: ps/help/en_us/vtm/controlapi/globalsettings docTags: createdAt: 2026-08-02T08:52:22.383Z --- URI: http\://soap.zeus.com/zxtm/1.0/GlobalSettings/ The Global Settings interface allows management of the traffic manager settings. ### Methods ### addApplianceReturnPathRoutes( value ) throws InvalidInput, DeploymentError Add a set of return path routes (MAC/IP mappings) to the configuration. ```bash void addApplianceReturnPathRoutes( GlobalSettings.ReturnPathRoute[] value ) ``` ### addApplianceReturnPathRoutesByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Add a set of return path routes (MAC/IP mappings) to the configuration. This is a location specific function, any action will operate on the specified location. ```bash void addApplianceReturnPathRoutesByLocation( String location GlobalSettings.ReturnPathRoute[] value ) ``` ### addFlipperFrontendCheckAddresses( values ) throws InvalidInput, DeploymentError Add new IP addresses to the list that should be used to check front-end connectivity ```bash void addFlipperFrontendCheckAddresses( String[] values ) ``` ### addFlipperFrontendCheckAddressesByLocation( location, values ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Add new IP addresses to the list that should be used to check front-end connectivity This is a location specific function, any action will operate on the specified location. ```bash void addFlipperFrontendCheckAddressesByLocation( String location String[] values ) ``` ### addLicenseServers( values ) throws InvalidInput, DeploymentError Add A list of license servers for FLA licensing. ```bash void addLicenseServers( String[] values ) ``` ### addLicenseServersByLocation( location, values ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Add A list of license servers for FLA licensing. This is a location specific function, any action will operate on the specified location. ```bash void addLicenseServersByLocation( String location String[] values ) ``` ### getASPSessionCacheSize() Get the maximum number of entries in the ASP session cache. ```bash Unsigned Integer getASPSessionCacheSize() ``` ### getASPSessionCacheSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum number of entries in the ASP session cache. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getASPSessionCacheSizeByLocation( String location ) ``` ### getAcceptingDelay() Get how often each traffic manager child process checks whether it should be accepting new connections. ```bash Unsigned Integer getAcceptingDelay() ``` ### getAcceptingDelayByLocation( location ) throws ObjectDoesNotExist Get how often each traffic manager child process checks whether it should be accepting new connections. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getAcceptingDelayByLocation( String location ) ``` ### getAdminAllowRehandshake() Get whether SSL / TLS re-handshakes are supported. ```bash GlobalSettings.AdminAllowRehandshake getAdminAllowRehandshake() ``` ### getAdminDiffieHellmanKeyLength() Get the number of bits to use for Diffie-Hellman keys ```bash GlobalSettings.AdminDiffieHellmanKeyLength getAdminDiffieHellmanKeyLength() ``` ### getAdminHonorFallbackSCSV() Get whether admin server, internal control port and config daemon honor the Fallback SCSV ```bash Boolean getAdminHonorFallbackSCSV() ``` ### getAdminInsertExtraFragment() Get whether admin server SSL3 and TLS1 use one byte fragments ```bash Boolean getAdminInsertExtraFragment() ``` ### getAdminMinRehandshakeInterval() Get the minimum time interval (in milliseconds) between handshakes on a single SSL3/TLS connection. ```bash Unsigned Integer getAdminMinRehandshakeInterval() ``` ### getAdminSSLCiphers() Get the list of configured SSL ciphers for admin server and internal connections (available ciphers can be displayed using the command $ZEUSHOME/zxtm/bin/zeus.zxtm -s). ```bash String getAdminSSLCiphers() ``` ### getAdminSSLEllipticCurves() Get the elliptic curve preference list for SSL connections to the admin server and within the traffic manager cluster. ```bash String getAdminSSLEllipticCurves() ``` ### getAdminSSLMaxHandshakeMessageSize() Get the maximum acceptable size (in bytes) a SSL handshake message is permitted to be for admin and internal connections. ```bash Unsigned Integer getAdminSSLMaxHandshakeMessageSize() ``` ### getAdminSSLPreventTimingSideChannels() Get an obsolete config value that has no effect. ```bash Boolean getAdminSSLPreventTimingSideChannels() ``` ### getAdminSSLSignatureAlgorithms() Get the SSL signature algorithms preference list for SSL connections to the admin server and within the zxtm cluster. ```bash String getAdminSSLSignatureAlgorithms() ``` ### getAdminSSLSupportTLS11() Get whether TLSv1.1 support is enabled for admin server and internal connections. ```bash Boolean getAdminSSLSupportTLS11() ``` ### getAdminSSLSupportTLS12() Get whether TLSv1.2 support is enabled for admin server and internal connections. ```bash Boolean getAdminSSLSupportTLS12() ``` ### getAdminSSLSupportTLS13() Get whether TLSv1.3 support is enabled for admin server and internal connections. ```bash Boolean getAdminSSLSupportTLS13() ``` ### getAdminSupportSSL2() This method is now deprecated. ```bash Boolean getAdminSupportSSL2() ``` ### getAdminSupportSSL3() Get whether SSLv3 support is enabled for admin server and internal connections. ```bash Boolean getAdminSupportSSL3() ``` ### getAdminSupportTLS1() Get whether TLSv1 support is enabled for admin server and internal connections. ```bash Boolean getAdminSupportTLS1() ``` ### getAfmEnabled() Get whether the Web Application Firewall is enabled ```bash Boolean getAfmEnabled() ``` ### getAlertEmailInterval() Get the length of time between alert emails, in seconds. Several alert messages will be stored up and sent in one email. ```bash Unsigned Integer getAlertEmailInterval() ``` ### getAlertEmailIntervalByLocation( location ) throws ObjectDoesNotExist Get the length of time between alert emails, in seconds. Several alert messages will be stored up and sent in one email. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getAlertEmailIntervalByLocation( String location ) ``` ### getAlertEmailMaxAttempts() Get the number of times to attempt sending an email before giving up. ```bash Unsigned Integer getAlertEmailMaxAttempts() ``` ### getAlertEmailMaxAttemptsByLocation( location ) throws ObjectDoesNotExist Get the number of times to attempt sending an email before giving up. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getAlertEmailMaxAttemptsByLocation( String location ) ``` ### getAllowConsecutiveChars() Get whether the same character can appear consecutively in passwords. ```bash Boolean getAllowConsecutiveChars() ``` ### getApplianceReturnPathRoutes() Get the set of return path routes (MAC/IP mappings) in the configuration. ```bash GlobalSettings.ReturnPathRoute[] getApplianceReturnPathRoutes() ``` ### getApplianceReturnPathRoutesByLocation( location ) throws ObjectDoesNotExist Get the set of return path routes (MAC/IP mappings) in the configuration. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.ReturnPathRoute[] getApplianceReturnPathRoutesByLocation( String location ) ``` ### getApplianceReturnPathRoutingEnabled() Get whether return path routing is enabled ```bash Boolean getApplianceReturnPathRoutingEnabled() ``` ### getApplianceReturnPathRoutingEnabledByLocation( location ) throws ObjectDoesNotExist Get whether return path routing is enabled This is a location specific function, any action will operate on the specified location. ```bash Boolean getApplianceReturnPathRoutingEnabledByLocation( String location ) ``` ### getAptimizerMaxDependentFetchSize() Get the maximum size of a dependent resource that can be sent to Web Accelerator. Set to 0 to disable limit. ```bash String getAptimizerMaxDependentFetchSize() ``` ### getAptimizerMaxOriginalContentBufferSize() Get the maximum size of original content buffer for content sent to Web Accelerator. ```bash String getAptimizerMaxOriginalContentBufferSize() ``` ### getAptimizerWatchdogInterval() Get How long (in seconds) the Web Accelerator watchdog mechanism should keep count of crashes for. ```bash Unsigned Integer getAptimizerWatchdogInterval() ``` ### getAptimizerWatchdogLimit() Get the maximum number of times the Web Accelerator sub-process will be restarted. ```bash Unsigned Integer getAptimizerWatchdogLimit() ``` ### getAuditlogViaEventd() Get whether the auditlog is to be mirrored to EventD. ```bash Boolean getAuditlogViaEventd() ``` ### getAuditlogViaEventdByLocation( location ) throws ObjectDoesNotExist Get whether the auditlog is to be mirrored to EventD. This is a location specific function, any action will operate on the specified location. ```bash Boolean getAuditlogViaEventdByLocation( String location ) ``` ### getAuditlogViaSyslog() Get whether the auditlog is to be mirrored to the syslog ```bash Boolean getAuditlogViaSyslog() ``` ### getAuditlogViaSyslogByLocation( location ) throws ObjectDoesNotExist Get whether the auditlog is to be mirrored to the syslog This is a location specific function, any action will operate on the specified location. ```bash Boolean getAuditlogViaSyslogByLocation( String location ) ``` ### getAuthSamlKeyLifetime() Get the lifetime of keys used to encrypt SAML SP session stored externally ```bash Unsigned Integer getAuthSamlKeyLifetime() ``` ### getAuthSamlKeyRotationInterval() Get the rotation interval of keys used to encrypt SAML SP session stored externally ```bash Unsigned Integer getAuthSamlKeyRotationInterval() ``` ### getAutoscalerVerbose() Get detailed logging of autoscaler status and actions ```bash Boolean getAutoscalerVerbose() ``` ### getAutoscalerVerboseByLocation( location ) throws ObjectDoesNotExist Get detailed logging of autoscaler status and actions This is a location specific function, any action will operate on the specified location. ```bash Boolean getAutoscalerVerboseByLocation( String location ) ``` ### getBackendKeepaliveTimeout() getBackendKeepaliveTimeout is deprecated, please use getIdleConnectionTimeout instead. ```bash Unsigned Integer getBackendKeepaliveTimeout() ``` ### getBackendKeepaliveTimeoutByLocation( location ) throws ObjectDoesNotExist getBackendKeepaliveTimeout is deprecated, please use getIdleConnectionTimeout instead. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getBackendKeepaliveTimeoutByLocation( String location ) ``` ### getBandwidthSharing() This method is now obsolete and is replaced by Catalog.Bandwidth.getSharing. ```bash Boolean getBandwidthSharing() ``` ### getBannerAccept() Get whether or not users must explicitly agree to the displayed login\_banner text before logging in to the Admin Server. ```bash Boolean getBannerAccept() ``` ### getBgpAsNumber() Get the number of the BGP AS in which the traffic manager will operate. ```bash Unsigned Integer getBgpAsNumber() ``` ### getBgpAsNumberByLocation( location ) throws ObjectDoesNotExist Get the number of the BGP AS in which the traffic manager will operate. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getBgpAsNumberByLocation( String location ) ``` ### getBgpEnabled() Get whether BGP Route Health Injection is enabled. ```bash Boolean getBgpEnabled() ``` ### getBgpEnabledByLocation( location ) throws ObjectDoesNotExist Get whether BGP Route Health Injection is enabled. This is a location specific function, any action will operate on the specified location. ```bash Boolean getBgpEnabledByLocation( String location ) ``` ### getChunkSize() Get the default chunk size for reading and writing data, in bytes. ```bash Unsigned Integer getChunkSize() ``` ### getChunkSizeByLocation( location ) throws ObjectDoesNotExist Get the default chunk size for reading and writing data, in bytes. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getChunkSizeByLocation( String location ) ``` ### getClientFirstOpt() Get whether client-first network socket optimisations should be used. ```bash Boolean getClientFirstOpt() ``` ### getClientFirstOptByLocation( location ) throws ObjectDoesNotExist Get whether client-first network socket optimisations should be used. This is a location specific function, any action will operate on the specified location. ```bash Boolean getClientFirstOptByLocation( String location ) ``` ### getControlAllowHosts() Get the hosts that are allowed to contact the internal administration port on each traffic manager. ```bash String getControlAllowHosts() ``` ### getControlAllowHostsByLocation( location ) throws ObjectDoesNotExist Get the hosts that are allowed to contact the internal administration port on each traffic manager. This is a location specific function, any action will operate on the specified location. ```bash String getControlAllowHostsByLocation( String location ) ``` ### getControlCanUpdateDefault() Get the value of the control!canupdate key for new cluster members. ```bash Boolean getControlCanUpdateDefault() ``` ### getDNSCacheExpiryTime() This method is now deprecated and is replaced by getDNSCacheMaxTTL/getDNSCacheMinTTL. ```bash Unsigned Integer getDNSCacheExpiryTime() ``` ### getDNSCacheExpiryTimeByLocation( location ) throws ObjectDoesNotExist This method is now deprecated and is replaced by getDNSCacheMaxTTL/getDNSCacheMinTTL. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getDNSCacheExpiryTimeByLocation( String location ) ``` ### getDNSCacheMaxTTL() Get the maximum time entries are stored in the DNS cache for, in seconds. ```bash Unsigned Integer getDNSCacheMaxTTL() ``` ### getDNSCacheMaxTTLByLocation( location ) throws ObjectDoesNotExist Get the maximum time entries are stored in the DNS cache for, in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getDNSCacheMaxTTLByLocation( String location ) ``` ### getDNSCacheMinTTL() Get the minimum time entries are stored in the DNS cache for, in seconds. ```bash Unsigned Integer getDNSCacheMinTTL() ``` ### getDNSCacheMinTTLByLocation( location ) throws ObjectDoesNotExist Get the minimum time entries are stored in the DNS cache for, in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getDNSCacheMinTTLByLocation( String location ) ``` ### getDNSCacheNegativeExpiryTime() Get the time failed lookups are stored in the DNS cache for, in seconds. ```bash Unsigned Integer getDNSCacheNegativeExpiryTime() ``` ### getDNSCacheNegativeExpiryTimeByLocation( location ) throws ObjectDoesNotExist Get the time failed lookups are stored in the DNS cache for, in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getDNSCacheNegativeExpiryTimeByLocation( String location ) ``` ### getDNSCacheSize() Get the maximum number of entries in the DNS cache. ```bash Unsigned Integer getDNSCacheSize() ``` ### getDNSCacheSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum number of entries in the DNS cache. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getDNSCacheSizeByLocation( String location ) ``` ### getDNSTimeout() Get the timeout for receiving a response from a DNS Server, in seconds. ```bash Unsigned Integer getDNSTimeout() ``` ### getDNSTimeoutByLocation( location ) throws ObjectDoesNotExist Get the timeout for receiving a response from a DNS Server, in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getDNSTimeoutByLocation( String location ) ``` ### getDataPlaneAccelerationCores() This method is now obsolete. ```bash GlobalSettings.DataPlaneAccelerationCores getDataPlaneAccelerationCores() ``` ### getDataPlaneAccelerationCoresByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash GlobalSettings.DataPlaneAccelerationCores getDataPlaneAccelerationCoresByLocation( String location ) ``` ### getDataPlaneAccelerationMode() This method is now obsolete. ```bash Boolean getDataPlaneAccelerationMode() ``` ### getDataPlaneAccelerationModeByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash Boolean getDataPlaneAccelerationModeByLocation( String location ) ``` ### getDataPlaneAccelerationTCPDelayAck() This method is now obsolete. ```bash Unsigned Integer getDataPlaneAccelerationTCPDelayAck() ``` ### getDataPlaneAccelerationTCPDelayAckByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash Unsigned Integer getDataPlaneAccelerationTCPDelayAckByLocation( String location ) ``` ### getDataPlaneAccelerationTCPWinScale() This method is now obsolete. ```bash Unsigned Integer getDataPlaneAccelerationTCPWinScale() ``` ### getDataPlaneAccelerationTCPWinScaleByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash Unsigned Integer getDataPlaneAccelerationTCPWinScaleByLocation( String location ) ``` ### getDeadTime() This method is now obsolete and is replaced by Pool.getNodeFailTime. ```bash Unsigned Integer getDeadTime() ``` ### getEC2AccessKeyID() Get DEPRECATED: Unused key. Assign an IAM Role to the EC2 instance to interact with AWS APIs. ```bash String getEC2AccessKeyID() ``` ### getEC2AccessKeyIDByLocation( location ) throws ObjectDoesNotExist Get DEPRECATED: Unused key. Assign an IAM Role to the EC2 instance to interact with AWS APIs. This is a location specific function, any action will operate on the specified location. ```bash String getEC2AccessKeyIDByLocation( String location ) ``` ### getEC2AwstoolTimeout() Get the timeout for awstool requests to the AWS Query Server ```bash Unsigned Integer getEC2AwstoolTimeout() ``` ### getEC2AwstoolTimeoutByLocation( location ) throws ObjectDoesNotExist Get the timeout for awstool requests to the AWS Query Server This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getEC2AwstoolTimeoutByLocation( String location ) ``` ### getEC2Endpoint() Get URL for the Amazon EC2 AWS endpoint. ```bash String getEC2Endpoint() ``` ### getEC2EndpointByLocation( location ) throws ObjectDoesNotExist Get URL for the Amazon EC2 AWS endpoint. This is a location specific function, any action will operate on the specified location. ```bash String getEC2EndpointByLocation( String location ) ``` ### getEC2MetadataServer() Get URL for the EC2 metadata server. ```bash String getEC2MetadataServer() ``` ### getEC2MetadataServerByLocation( location ) throws ObjectDoesNotExist Get URL for the EC2 metadata server. This is a location specific function, any action will operate on the specified location. ```bash String getEC2MetadataServerByLocation( String location ) ``` ### getEC2VerifyEndpointCert() Get Whether to verify Amazon EC2 endpoint's certificate using CAs present in SSL Certificate Authorities Catalog. ```bash Boolean getEC2VerifyEndpointCert() ``` ### getEC2VerifyEndpointCertByLocation( location ) throws ObjectDoesNotExist Get Whether to verify Amazon EC2 endpoint's certificate using CAs present in SSL Certificate Authorities Catalog. This is a location specific function, any action will operate on the specified location. ```bash Boolean getEC2VerifyEndpointCertByLocation( String location ) ``` ### getErrorLevel() This method is now deprecated. ```bash GlobalSettings.ErrorLevel getErrorLevel() ``` ### getErrorLevelByLocation( location ) throws ObjectDoesNotExist This method is now deprecated. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.ErrorLevel getErrorLevelByLocation( String location ) ``` ### getErrorLogFile() Get the filename that errors are logged to. ```bash String getErrorLogFile() ``` ### getErrorLogFileByLocation( location ) throws ObjectDoesNotExist Get the filename that errors are logged to. This is a location specific function, any action will operate on the specified location. ```bash String getErrorLogFileByLocation( String location ) ``` ### getFTPDataBindLow() Get whether your traffic manager should permit use of FTP data connection source ports lower than 1024. If 'No' your traffic manager can completely drop root privileges, if 'Yes' some or all privileges may be retained in order to bind to low ports. ```bash Boolean getFTPDataBindLow() ``` ### getFTPDataBindLowByLocation( location ) throws ObjectDoesNotExist Get whether your traffic manager should permit use of FTP data connection source ports lower than 1024. If 'No' your traffic manager can completely drop root privileges, if 'Yes' some or all privileges may be retained in order to bind to low ports. This is a location specific function, any action will operate on the specified location. ```bash Boolean getFTPDataBindLowByLocation( String location ) ``` ### getFipsEnabled() Get whether FIPS Mode is enabled. ```bash Boolean getFipsEnabled() ``` ### getFlipperArpCount() Get the number of ARP packets each traffic manager sends when an IP address is raised. ```bash Unsigned Integer getFlipperArpCount() ``` ### getFlipperArpCountByLocation( location ) throws ObjectDoesNotExist Get the number of ARP packets each traffic manager sends when an IP address is raised. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getFlipperArpCountByLocation( String location ) ``` ### getFlipperAutofailback() Get whether Traffic IPs should automatically failback to recovered machines. ```bash Boolean getFlipperAutofailback() ``` ### getFlipperAutofailbackByLocation( location ) throws ObjectDoesNotExist Get whether Traffic IPs should automatically failback to recovered machines. This is a location specific function, any action will operate on the specified location. ```bash Boolean getFlipperAutofailbackByLocation( String location ) ``` ### getFlipperAutofailbackDelay() Get the delay of automatic failback after a previous failover event. ```bash Unsigned Integer getFlipperAutofailbackDelay() ``` ### getFlipperAutofailbackDelayByLocation( location ) throws ObjectDoesNotExist Get the delay of automatic failback after a previous failover event. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getFlipperAutofailbackDelayByLocation( String location ) ``` ### getFlipperChildTimeout() Get how long (in seconds) the traffic manager should wait for status updates from any of the traffic manager's child processes before assuming one of them is no longer servicing traffic. ```bash Unsigned Integer getFlipperChildTimeout() ``` ### getFlipperChildTimeoutByLocation( location ) throws ObjectDoesNotExist Get how long (in seconds) the traffic manager should wait for status updates from any of the traffic manager's child processes before assuming one of them is no longer servicing traffic. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getFlipperChildTimeoutByLocation( String location ) ``` ### getFlipperFrontendCheckAddresses() Get the IP addresses that should be used to check front-end connectivity. ```bash String[] getFlipperFrontendCheckAddresses() ``` ### getFlipperFrontendCheckAddressesByLocation( location ) throws ObjectDoesNotExist Get the IP addresses that should be used to check front-end connectivity. This is a location specific function, any action will operate on the specified location. ```bash String[] getFlipperFrontendCheckAddressesByLocation( String location ) ``` ### getFlipperHeartbeatMethod() Get the method used to exchange cluster heartbeat messages. ```bash GlobalSettings.FlipperHeartbeatMethod getFlipperHeartbeatMethod() ``` ### getFlipperHeartbeatMethodByLocation( location ) throws ObjectDoesNotExist Get the method used to exchange cluster heartbeat messages. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.FlipperHeartbeatMethod getFlipperHeartbeatMethodByLocation( String location ) ``` ### getFlipperIGMPInterval() Get the interval between two unsolicited periodic IGMP Membership Report messages for Multi-Hosted Traffic IP Groups. ```bash Unsigned Integer getFlipperIGMPInterval() ``` ### getFlipperIGMPIntervalByLocation( location ) throws ObjectDoesNotExist Get the interval between two unsolicited periodic IGMP Membership Report messages for Multi-Hosted Traffic IP Groups. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getFlipperIGMPIntervalByLocation( String location ) ``` ### getFlipperL4AccelChildTimeout() This method is now obsolete. ```bash Unsigned Integer getFlipperL4AccelChildTimeout() ``` ### getFlipperL4AccelChildTimeoutByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash Unsigned Integer getFlipperL4AccelChildTimeoutByLocation( String location ) ``` ### getFlipperL4AccelSyncPort() This method is now obsolete. ```bash Unsigned Integer getFlipperL4AccelSyncPort() ``` ### getFlipperL4AccelSyncPortByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash Unsigned Integer getFlipperL4AccelSyncPortByLocation( String location ) ``` ### getFlipperMonitorInterval() Get how frequently (in milliseconds) each traffic manager checks and announces its connectivity. ```bash Unsigned Integer getFlipperMonitorInterval() ``` ### getFlipperMonitorIntervalByLocation( location ) throws ObjectDoesNotExist Get how frequently (in milliseconds) each traffic manager checks and announces its connectivity. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getFlipperMonitorIntervalByLocation( String location ) ``` ### getFlipperMonitorTimeout() Get how long (in seconds) each traffic manager waits for a response from its connectivity tests or from other traffic managers before registering a failure. ```bash Unsigned Integer getFlipperMonitorTimeout() ``` ### getFlipperMonitorTimeoutByLocation( location ) throws ObjectDoesNotExist Get how long (in seconds) each traffic manager waits for a response from its connectivity tests or from other traffic managers before registering a failure. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getFlipperMonitorTimeoutByLocation( String location ) ``` ### getFlipperMulticastAddress() Get the multicast address and port used to announce connectivity (e.g. 239.100.1.1:9090). ```bash String getFlipperMulticastAddress() ``` ### getFlipperMulticastAddressByLocation( location ) throws ObjectDoesNotExist Get the multicast address and port used to announce connectivity (e.g. 239.100.1.1:9090). This is a location specific function, any action will operate on the specified location. ```bash String getFlipperMulticastAddressByLocation( String location ) ``` ### getFlipperUnicastPort() Get the unicast UDP port used to announce connectivity (e.g. 9090) ```bash Unsigned Integer getFlipperUnicastPort() ``` ### getFlipperUnicastPortByLocation( location ) throws ObjectDoesNotExist Get the unicast UDP port used to announce connectivity (e.g. 9090) This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getFlipperUnicastPortByLocation( String location ) ``` ### getFlipperUseBindip() Get whether the heartbeat messages used for fault tolerance are only sent over the management network. ```bash Boolean getFlipperUseBindip() ``` ### getFlipperUseBindipByLocation( location ) throws ObjectDoesNotExist Get whether the heartbeat messages used for fault tolerance are only sent over the management network. This is a location specific function, any action will operate on the specified location. ```bash Boolean getFlipperUseBindipByLocation( String location ) ``` ### getFlipperVerbose() Get whether the traffic manager should logs all the connectivity tests. ```bash Boolean getFlipperVerbose() ``` ### getFlipperVerboseByLocation( location ) throws ObjectDoesNotExist Get whether the traffic manager should logs all the connectivity tests. This is a location specific function, any action will operate on the specified location. ```bash Boolean getFlipperVerboseByLocation( String location ) ``` ### getGLBLoadChangeLimit() Get the maximum change per second to load. ```bash Unsigned Integer getGLBLoadChangeLimit() ``` ### getGLBLoadChangeLimitByLocation( location ) throws ObjectDoesNotExist Get the maximum change per second to load. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getGLBLoadChangeLimitByLocation( String location ) ``` ### getGLBVerbose() Get whether GSLB should log all DNS queries ```bash Boolean getGLBVerbose() ``` ### getGLBVerboseByLocation( location ) throws ObjectDoesNotExist Get whether GSLB should log all DNS queries This is a location specific function, any action will operate on the specified location. ```bash Boolean getGLBVerboseByLocation( String location ) ``` ### getHistoricalTrafficDays() Get the length of time historical traffic information is kept for, in days (0=keep indefinitely). ```bash Unsigned Integer getHistoricalTrafficDays() ``` ### getHistoricalTrafficDaysByLocation( location ) throws ObjectDoesNotExist Get the length of time historical traffic information is kept for, in days (0=keep indefinitely). This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getHistoricalTrafficDaysByLocation( String location ) ``` ### getIPSessionCacheExpiry() Get IP session cache expiry time in seconds. ```bash Unsigned Integer getIPSessionCacheExpiry() ``` ### getIPSessionCacheExpiryByLocation( location ) throws ObjectDoesNotExist Get IP session cache expiry time in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getIPSessionCacheExpiryByLocation( String location ) ``` ### getIPSessionCacheSize() Get the maximum number of entries in the IP session cache. ```bash Unsigned Integer getIPSessionCacheSize() ``` ### getIPSessionCacheSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum number of entries in the IP session cache. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getIPSessionCacheSizeByLocation( String location ) ``` ### getIdleConnectionTimeout() Get how long unused HTTP keepalive connections should be kept before being discarded, in seconds. ```bash Unsigned Integer getIdleConnectionTimeout() ``` ### getIdleConnectionTimeoutByLocation( location ) throws ObjectDoesNotExist Get how long unused HTTP keepalive connections should be kept before being discarded, in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getIdleConnectionTimeoutByLocation( String location ) ``` ### getJ2EESessionCacheExpiry() Get J2EE session cache expiry time in seconds. ```bash Unsigned Integer getJ2EESessionCacheExpiry() ``` ### getJ2EESessionCacheExpiryByLocation( location ) throws ObjectDoesNotExist Get J2EE session cache expiry time in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getJ2EESessionCacheExpiryByLocation( String location ) ``` ### getJ2EESessionCacheSize() Get the maximum number of entries in the J2EE session cache. ```bash Unsigned Integer getJ2EESessionCacheSize() ``` ### getJ2EESessionCacheSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum number of entries in the J2EE session cache. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getJ2EESessionCacheSizeByLocation( String location ) ``` ### getJavaClasspath() Get extra Java CLASSPATH settings required for servlets. ```bash String getJavaClasspath() ``` ### getJavaClasspathByLocation( location ) throws ObjectDoesNotExist Get extra Java CLASSPATH settings required for servlets. This is a location specific function, any action will operate on the specified location. ```bash String getJavaClasspathByLocation( String location ) ``` ### getJavaCommand() Get the command (and arguments) used to start Java. ```bash String getJavaCommand() ``` ### getJavaCommandByLocation( location ) throws ObjectDoesNotExist Get the command (and arguments) used to start Java. This is a location specific function, any action will operate on the specified location. ```bash String getJavaCommandByLocation( String location ) ``` ### getJavaEnabled() Get whether to enable Java support. ```bash Boolean getJavaEnabled() ``` ### getJavaEnabledByLocation( location ) throws ObjectDoesNotExist Get whether to enable Java support. This is a location specific function, any action will operate on the specified location. ```bash Boolean getJavaEnabledByLocation( String location ) ``` ### getJavaLib() Get the location of the java library directory ```bash String getJavaLib() ``` ### getJavaLibByLocation( location ) throws ObjectDoesNotExist Get the location of the java library directory This is a location specific function, any action will operate on the specified location. ```bash String getJavaLibByLocation( String location ) ``` ### getJavaMaxConns() Get the maximum number of Java threads ```bash Unsigned Integer getJavaMaxConns() ``` ### getJavaMaxConnsByLocation( location ) throws ObjectDoesNotExist Get the maximum number of Java threads This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getJavaMaxConnsByLocation( String location ) ``` ### getJavaSessionAge() Get the default maximum age of Java session persistence ```bash Unsigned Integer getJavaSessionAge() ``` ### getJavaSessionAgeByLocation( location ) throws ObjectDoesNotExist Get the default maximum age of Java session persistence This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getJavaSessionAgeByLocation( String location ) ``` ### getKerberosVerbose() Get whether the traffic manager should log all Kerberos activity. ```bash Boolean getKerberosVerbose() ``` ### getKerberosVerboseByLocation( location ) throws ObjectDoesNotExist Get whether the traffic manager should log all Kerberos activity. This is a location specific function, any action will operate on the specified location. ```bash Boolean getKerberosVerboseByLocation( String location ) ``` ### getL4AccelMaxConcurrentConnections() This method is now obsolete. ```bash Unsigned Integer getL4AccelMaxConcurrentConnections() ``` ### getL4AccelMaxConcurrentConnectionsByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash Unsigned Integer getL4AccelMaxConcurrentConnectionsByLocation( String location ) ``` ### getLicenseServers() Get A list of license servers for FLA licensing. ```bash String[] getLicenseServers() ``` ### getLicenseServersByLocation( location ) throws ObjectDoesNotExist Get A list of license servers for FLA licensing. This is a location specific function, any action will operate on the specified location. ```bash String[] getLicenseServersByLocation( String location ) ``` ### getListenQueueSize() Get the size of the listen queue for managing incoming connections. ```bash Unsigned Integer getListenQueueSize() ``` ### getListenQueueSizeByLocation( location ) throws ObjectDoesNotExist Get the size of the listen queue for managing incoming connections. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getListenQueueSizeByLocation( String location ) ``` ### getLogExportAuthHTTP() Get the HTTP authentication method to use when exporting log entries. ```bash GlobalSettings.LogExportAuthHTTP getLogExportAuthHTTP() ``` ### getLogExportAuthHTTPByLocation( location ) throws ObjectDoesNotExist Get the HTTP authentication method to use when exporting log entries. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.LogExportAuthHTTP getLogExportAuthHTTPByLocation( String location ) ``` ### getLogExportAuthHecToken() Get the HTTP Event Collector token to use for HTTP authentication with a Splunk server. ```bash String getLogExportAuthHecToken() ``` ### getLogExportAuthHecTokenByLocation( location ) throws ObjectDoesNotExist Get the HTTP Event Collector token to use for HTTP authentication with a Splunk server. This is a location specific function, any action will operate on the specified location. ```bash String getLogExportAuthHecTokenByLocation( String location ) ``` ### getLogExportAuthUsername() Get the username to use for HTTP basic authentication. ```bash String getLogExportAuthUsername() ``` ### getLogExportAuthUsernameByLocation( location ) throws ObjectDoesNotExist Get the username to use for HTTP basic authentication. This is a location specific function, any action will operate on the specified location. ```bash String getLogExportAuthUsernameByLocation( String location ) ``` ### getLogExportEnabled() Get whether to monitor log files and export entries to the configured endpoint. ```bash Boolean getLogExportEnabled() ``` ### getLogExportEnabledByLocation( location ) throws ObjectDoesNotExist Get whether to monitor log files and export entries to the configured endpoint. This is a location specific function, any action will operate on the specified location. ```bash Boolean getLogExportEnabledByLocation( String location ) ``` ### getLogExportEndpoint() Get the URL to which log entries should be sent. ```bash String getLogExportEndpoint() ``` ### getLogExportEndpointByLocation( location ) throws ObjectDoesNotExist Get the URL to which log entries should be sent. This is a location specific function, any action will operate on the specified location. ```bash String getLogExportEndpointByLocation( String location ) ``` ### getLogExportRequestTimeout() Get the number of seconds after which HTTP requests sent to the configured endpoint will be considered to have failed if no response is received. ```bash Unsigned Integer getLogExportRequestTimeout() ``` ### getLogExportRequestTimeoutByLocation( location ) throws ObjectDoesNotExist Get the number of seconds after which HTTP requests sent to the configured endpoint will be considered to have failed if no response is received. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getLogExportRequestTimeoutByLocation( String location ) ``` ### getLogExportTLSVerify() Get whether the server certificate should be verified when connecting to the endpoint. If enabled, server certificates that do not match the server name, are self-signed, have expired, have been revoked, or that are signed by an unknown CA will be rejected. ```bash Boolean getLogExportTLSVerify() ``` ### getLogExportTLSVerifyByLocation( location ) throws ObjectDoesNotExist Get whether the server certificate should be verified when connecting to the endpoint. If enabled, server certificates that do not match the server name, are self-signed, have expired, have been revoked, or that are signed by an unknown CA will be rejected. This is a location specific function, any action will operate on the specified location. ```bash Boolean getLogExportTLSVerifyByLocation( String location ) ``` ### getLogFlushFlushTime() Get the length of time to wait before flushing the request log files for each virtual server, in seconds. ```bash Unsigned Integer getLogFlushFlushTime() ``` ### getLogFlushFlushTimeByLocation( location ) throws ObjectDoesNotExist Get the length of time to wait before flushing the request log files for each virtual server, in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getLogFlushFlushTimeByLocation( String location ) ``` ### getLogInterval() Get the length of time between log messages for log intensive features e.g. SLM, in seconds. ```bash Unsigned Integer getLogInterval() ``` ### getLogIntervalByLocation( location ) throws ObjectDoesNotExist Get the length of time between log messages for log intensive features e.g. SLM, in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getLogIntervalByLocation( String location ) ``` ### getLogRate() Get is the maximum number of connection errors logged per second. ```bash Unsigned Integer getLogRate() ``` ### getLogRateByLocation( location ) throws ObjectDoesNotExist Get is the maximum number of connection errors logged per second. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getLogRateByLocation( String location ) ``` ### getLogReopenTime() Get the length of time to wait before re-opening request log files, to handle log file rotation, in seconds. ```bash Unsigned Integer getLogReopenTime() ``` ### getLogReopenTimeByLocation( location ) throws ObjectDoesNotExist Get the length of time to wait before re-opening request log files, to handle log file rotation, in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getLogReopenTimeByLocation( String location ) ``` ### getLoginBanner() Get the banner text to be shown on the Admin Server login page and before logging in to appliance SSH servers. ```bash String getLoginBanner() ``` ### getLoginDelay() Get the number of seconds before another login attempt can be made after a failed attempt. ```bash Unsigned Integer getLoginDelay() ``` ### getMaxAccepting() Get how many traffic manager child processes accept new connections. ```bash Unsigned Integer getMaxAccepting() ``` ### getMaxAcceptingByLocation( location ) throws ObjectDoesNotExist Get how many traffic manager child processes accept new connections. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getMaxAcceptingByLocation( String location ) ``` ### getMaxGlobalTCPBufferSize() Get the maximum amount of memory allowed to be used by the vTM to buffer network data in user space for all TCP connections. ```bash String getMaxGlobalTCPBufferSize() ``` ### getMaxGlobalTCPBufferSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum amount of memory allowed to be used by the vTM to buffer network data in user space for all TCP connections. This is a location specific function, any action will operate on the specified location. ```bash String getMaxGlobalTCPBufferSizeByLocation( String location ) ``` ### getMaxIdleConnections() Get the maximum number of unused HTTP keepalive connections to all nodes that should maintained for re-use. ```bash Unsigned Integer getMaxIdleConnections() ``` ### getMaxIdleConnectionsByLocation( location ) throws ObjectDoesNotExist Get the maximum number of unused HTTP keepalive connections to all nodes that should maintained for re-use. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getMaxIdleConnectionsByLocation( String location ) ``` ### getMaxKeepalives() getMaxKeepalives is deprecated, please use getMaxIdleConnections instead. ```bash Unsigned Integer getMaxKeepalives() ``` ### getMaxKeepalivesByLocation( location ) throws ObjectDoesNotExist getMaxKeepalives is deprecated, please use getMaxIdleConnections instead. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getMaxKeepalivesByLocation( String location ) ``` ### getMaxLoginAttempts() Get the number of sequential failed login attempts that will cause a user account to be suspended. Setting this to 0 disables this feature. ```bash Unsigned Integer getMaxLoginAttempts() ``` ### getMaxLoginExternal() Get whether or not usernames blocked due to the max\_login\_attempts limit should also be blocked from authentication against external services (such as LDAP and RADIUS). ```bash Boolean getMaxLoginExternal() ``` ### getMaxLoginSuspensionTime() Get number of minutes to suspend users who have exceeded the max\_login\_attempts limit. ```bash Unsigned Integer getMaxLoginSuspensionTime() ``` ### getMaxRetries() This method is now obsolete and is replaced by Pool.getNodeConnectionAttempts. ```bash Unsigned Integer getMaxRetries() ``` ### getMaximumFDCount() Get the maximum number of file descriptors that your traffic manager will allocate ```bash Unsigned Integer getMaximumFDCount() ``` ### getMaximumFDCountByLocation( location ) throws ObjectDoesNotExist Get the maximum number of file descriptors that your traffic manager will allocate This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getMaximumFDCountByLocation( String location ) ``` ### getMinAlphaChars() Get the minimum number of alphabetic characters in a password. ```bash Unsigned Integer getMinAlphaChars() ``` ### getMinNumericChars() Get the minimum number of numeric characters in a password. ```bash Unsigned Integer getMinNumericChars() ``` ### getMinPasswordLength() Get the minimum number of characters a password must contain. ```bash Unsigned Integer getMinPasswordLength() ``` ### getMinSpecialChars() Get the minimum number of special characters in a password. ```bash Unsigned Integer getMinSpecialChars() ``` ### getMinUppercaseChars() Get the minimum number of uppercase characters in a password. ```bash Unsigned Integer getMinUppercaseChars() ``` ### getMonitorNumNodes() Get the maximum number of nodes, pools and locations that can be monitored. ```bash Unsigned Integer getMonitorNumNodes() ``` ### getMonitorNumNodesByLocation( location ) throws ObjectDoesNotExist Get the maximum number of nodes, pools and locations that can be monitored. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getMonitorNumNodesByLocation( String location ) ``` ### getMultipleAccept() Get whether your traffic manager should try and read multiple new connections each time a new client connects. ```bash Boolean getMultipleAccept() ``` ### getMultipleAcceptByLocation( location ) throws ObjectDoesNotExist Get whether your traffic manager should try and read multiple new connections each time a new client connects. This is a location specific function, any action will operate on the specified location. ```bash Boolean getMultipleAcceptByLocation( String location ) ``` ### getNodeConnectionAttempts() This method is now obsolete and is replaced by Pool.getNodeConnectionAttempts. ```bash Unsigned Integer getNodeConnectionAttempts() ``` ### getNodeFailTime() This method is now obsolete and is replaced by Pool.getNodeFailTime. ```bash Unsigned Integer getNodeFailTime() ``` ### getOCSPCacheSize() Get the maximum number of cached client certificate OCSP results stored. This cache is used to speed up OCSP checks against client certificates by caching results. ```bash Unsigned Integer getOCSPCacheSize() ``` ### getOCSPCacheSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum number of cached client certificate OCSP results stored. This cache is used to speed up OCSP checks against client certificates by caching results. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getOCSPCacheSizeByLocation( String location ) ``` ### getOspfv2Area() Get the OSPF area in which the traffic manager will operate. ```bash String getOspfv2Area() ``` ### getOspfv2AreaByLocation( location ) throws ObjectDoesNotExist Get the OSPF area in which the traffic manager will operate. This is a location specific function, any action will operate on the specified location. ```bash String getOspfv2AreaByLocation( String location ) ``` ### getOspfv2AreaType() Get the type of OSPF area ```bash GlobalSettings.Ospfv2AreaType getOspfv2AreaType() ``` ### getOspfv2AreaTypeByLocation( location ) throws ObjectDoesNotExist Get the type of OSPF area This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.Ospfv2AreaType getOspfv2AreaTypeByLocation( String location ) ``` ### getOspfv2AuthenticationKeyIdA() Get the OSPF key ID ```bash Unsigned Integer getOspfv2AuthenticationKeyIdA() ``` ### getOspfv2AuthenticationKeyIdAByLocation( location ) throws ObjectDoesNotExist Get the OSPF key ID This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getOspfv2AuthenticationKeyIdAByLocation( String location ) ``` ### getOspfv2AuthenticationKeyIdB() Get the OSPF key ID ```bash Unsigned Integer getOspfv2AuthenticationKeyIdB() ``` ### getOspfv2AuthenticationKeyIdBByLocation( location ) throws ObjectDoesNotExist Get the OSPF key ID This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getOspfv2AuthenticationKeyIdBByLocation( String location ) ``` ### getOspfv2AuthenticationSharedSecretA() Get the OSPF MD5 shared secret. ```bash String getOspfv2AuthenticationSharedSecretA() ``` ### getOspfv2AuthenticationSharedSecretAByLocation( location ) throws ObjectDoesNotExist Get the OSPF MD5 shared secret. This is a location specific function, any action will operate on the specified location. ```bash String getOspfv2AuthenticationSharedSecretAByLocation( String location ) ``` ### getOspfv2AuthenticationSharedSecretB() Get the OSPF MD5 shared secret. ```bash String getOspfv2AuthenticationSharedSecretB() ``` ### getOspfv2AuthenticationSharedSecretBByLocation( location ) throws ObjectDoesNotExist Get the OSPF MD5 shared secret. This is a location specific function, any action will operate on the specified location. ```bash String getOspfv2AuthenticationSharedSecretBByLocation( String location ) ``` ### getOspfv2DeadInterval() Get the number of seconds before declaring a silent router down. ```bash Unsigned Integer getOspfv2DeadInterval() ``` ### getOspfv2DeadIntervalByLocation( location ) throws ObjectDoesNotExist Get the number of seconds before declaring a silent router down. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getOspfv2DeadIntervalByLocation( String location ) ``` ### getOspfv2Enabled() Get whether OSPF Route Health Injection is enabled ```bash Boolean getOspfv2Enabled() ``` ### getOspfv2EnabledByLocation( location ) throws ObjectDoesNotExist Get whether OSPF Route Health Injection is enabled This is a location specific function, any action will operate on the specified location. ```bash Boolean getOspfv2EnabledByLocation( String location ) ``` ### getOspfv2HelloInterval() Get the interval at which OSPF "hello" packets are sent to the network. ```bash Unsigned Integer getOspfv2HelloInterval() ``` ### getOspfv2HelloIntervalByLocation( location ) throws ObjectDoesNotExist Get the interval at which OSPF "hello" packets are sent to the network. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getOspfv2HelloIntervalByLocation( String location ) ``` ### getOspfv2RouterDeadInterval() This method is now deprecated and is replaced by getOspfv2DeadInterval. ```bash Unsigned Integer getOspfv2RouterDeadInterval() ``` ### getOspfv2RouterDeadIntervalByLocation( location ) throws ObjectDoesNotExist This method is now deprecated and is replaced by getOspfv2DeadInterval. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getOspfv2RouterDeadIntervalByLocation( String location ) ``` ### getPasswordChangesPerDay() Get the maximum number of times a password can be changed every 24 hours. ```bash Unsigned Integer getPasswordChangesPerDay() ``` ### getPasswordReuseAfter() Get the number of times a password must have been changed before it can be reused. ```bash Unsigned Integer getPasswordReuseAfter() ``` ### getPostLoginBanner() Get the banner text to be displayed on the appliance console after login. ```bash String getPostLoginBanner() ``` ### getProtectionConncountSize() Get the amount of shared memory reserved for an inter-process table of combined connection counts used by Service Protection classes (specified as an absolute size, eg 20MB). ```bash String getProtectionConncountSize() ``` ### getProtectionConncountSizeByLocation( location ) throws ObjectDoesNotExist Get the amount of shared memory reserved for an inter-process table of combined connection counts used by Service Protection classes (specified as an absolute size, eg 20MB). This is a location specific function, any action will operate on the specified location. ```bash String getProtectionConncountSizeByLocation( String location ) ``` ### getRESTAuthTimeout() Get REST authentication timeout. ```bash Unsigned Integer getRESTAuthTimeout() ``` ### getRESTEnabled() Get whether REST service is enabled. ```bash Boolean getRESTEnabled() ``` ### getRESTMaxHTTPHeaderLength() Get the maximum allowed length in bytes of a HTTP request's headers. ```bash Unsigned Integer getRESTMaxHTTPHeaderLength() ``` ### getRESTMaximumFDCount() Get the maximum number of file descriptors that the REST API will allocate. ```bash Unsigned Integer getRESTMaximumFDCount() ``` ### getRESTReplicateAbsoluteTime() Get Absolute time before configuration replication via REST. ```bash Unsigned Integer getRESTReplicateAbsoluteTime() ``` ### getRESTReplicateLullTime() Get Lull time for configuration replication via REST. ```bash Unsigned Integer getRESTReplicateLullTime() ``` ### getRESTReplicateTimeout() Get the configuration replication timeout via REST. ```bash Unsigned Integer getRESTReplicateTimeout() ``` ### getRateClassLimit() Get the maximum number of Rate classes allowed. ```bash Unsigned Integer getRateClassLimit() ``` ### getRateClassLimitByLocation( location ) throws ObjectDoesNotExist Get the maximum number of Rate classes allowed. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getRateClassLimitByLocation( String location ) ``` ### getRecentConns() Get the details of how many recently closed connections each traffic manager process should save for use with the Connections page. ```bash Unsigned Integer getRecentConns() ``` ### getRecentConnsByLocation( location ) throws ObjectDoesNotExist Get the details of how many recently closed connections each traffic manager process should save for use with the Connections page. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getRecentConnsByLocation( String location ) ``` ### getRecentConnsRetainTime() Get for how long a snapshot should be retained on the Connections page. ```bash Unsigned Integer getRecentConnsRetainTime() ``` ### getRecentConnsRetainTimeByLocation( location ) throws ObjectDoesNotExist Get for how long a snapshot should be retained on the Connections page. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getRecentConnsRetainTimeByLocation( String location ) ``` ### getRecentConnsSnapshotSize() Get the maximum number of connections each traffic manager process should show for a snapshot on the Connections page. ```bash Unsigned Integer getRecentConnsSnapshotSize() ``` ### getRecentConnsSnapshotSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum number of connections each traffic manager process should show for a snapshot on the Connections page. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getRecentConnsSnapshotSizeByLocation( String location ) ``` ### getSLMClassLimit() Get the maximum number of SLM classes allowed. ```bash Unsigned Integer getSLMClassLimit() ``` ### getSLMClassLimitByLocation( location ) throws ObjectDoesNotExist Get the maximum number of SLM classes allowed. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSLMClassLimitByLocation( String location ) ``` ### getSNATIPLimit() This method is now obsolete. ```bash Unsigned Integer getSNATIPLimit() ``` ### getSNATIPLimitByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash Unsigned Integer getSNATIPLimitByLocation( String location ) ``` ### getSNATIPLocalPortRangeHigh() This method is now obsolete. ```bash Unsigned Integer getSNATIPLocalPortRangeHigh() ``` ### getSNATIPLocalPortRangeHighByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash Unsigned Integer getSNATIPLocalPortRangeHighByLocation( String location ) ``` ### getSNATSharedPoolSize() This method is now obsolete. ```bash Unsigned Integer getSNATSharedPoolSize() ``` ### getSNATSharedPoolSizeByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash Unsigned Integer getSNATSharedPoolSizeByLocation( String location ) ``` ### getSNMPUserCounters() Get the number of user defined SNMP counters (this single parameter dictates the numbers of both 32- and 64-bit user counters - there is always the same number of counters of each type). ```bash Unsigned Integer getSNMPUserCounters() ``` ### getSNMPUserCountersByLocation( location ) throws ObjectDoesNotExist Get the number of user defined SNMP counters (this single parameter dictates the numbers of both 32- and 64-bit user counters - there is always the same number of counters of each type). This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSNMPUserCountersByLocation( String location ) ``` ### getSSL3AllowRehandshake() This methods is deprecated and is replaced by GlobalSettings.getSSLAllowRehandshake. ```bash GlobalSettings.SSL3AllowRehandshake getSSL3AllowRehandshake() ``` ### getSSL3AllowRehandshakeByLocation( location ) throws ObjectDoesNotExist This methods is deprecated and is replaced by GlobalSettings.getSSLAllowRehandshake. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.SSL3AllowRehandshake getSSL3AllowRehandshakeByLocation( String location ) ``` ### getSSL3Ciphers() This method is deprecated and is replaced by GlobalSettings.getSSLCipherSuites. ```bash String getSSL3Ciphers() ``` ### getSSL3CiphersByLocation( location ) throws ObjectDoesNotExist This method is deprecated and is replaced by GlobalSettings.getSSLCipherSuites. This is a location specific function, any action will operate on the specified location. ```bash String getSSL3CiphersByLocation( String location ) ``` ### getSSL3DiffieHellmanKeyLength() This methods is deprecated and is replaced by GlobalSettings.getSSLDiffieHellmanModulusSize. ```bash GlobalSettings.SSL3DiffieHellmanKeyLength getSSL3DiffieHellmanKeyLength() ``` ### getSSL3DiffieHellmanKeyLengthByLocation( location ) throws ObjectDoesNotExist This methods is deprecated and is replaced by GlobalSettings.getSSLDiffieHellmanModulusSize. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.SSL3DiffieHellmanKeyLength getSSL3DiffieHellmanKeyLengthByLocation( String location ) ``` ### getSSL3MinRehandshakeInterval() This methods is deprecated and is replaced by GlobalSettings.getSSLMinRehandshakeInterval. ```bash Unsigned Integer getSSL3MinRehandshakeInterval() ``` ### getSSLAllowRehandshake() Get whether SSL/TLS re-handshakes are supported. ```bash GlobalSettings.SSLAllowRehandshake getSSLAllowRehandshake() ``` ### getSSLAllowRehandshakeByLocation( location ) throws ObjectDoesNotExist Get whether SSL/TLS re-handshakes are supported. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.SSLAllowRehandshake getSSLAllowRehandshakeByLocation( String location ) ``` ### getSSLAzureClientID() Get the client identifier for the Azure Key Vault. ```bash String getSSLAzureClientID() ``` ### getSSLAzureClientIDByLocation( location ) throws ObjectDoesNotExist Get the client identifier for the Azure Key Vault. This is a location specific function, any action will operate on the specified location. ```bash String getSSLAzureClientIDByLocation( String location ) ``` ### getSSLAzureVaultURL() Get the URL of the Azure Key Vault REST API. ```bash String getSSLAzureVaultURL() ``` ### getSSLAzureVaultURLByLocation( location ) throws ObjectDoesNotExist Get the URL of the Azure Key Vault REST API. This is a location specific function, any action will operate on the specified location. ```bash String getSSLAzureVaultURLByLocation( String location ) ``` ### getSSLAzureVerifyRESTAPICert() Get whether the SSL certificate of the Azure Key Vault REST API will be verified using CAs present in the SSL Certificate Authorities Catalog. ```bash Boolean getSSLAzureVerifyRESTAPICert() ``` ### getSSLAzureVerifyRESTAPICertByLocation( location ) throws ObjectDoesNotExist Get whether the SSL certificate of the Azure Key Vault REST API will be verified using CAs present in the SSL Certificate Authorities Catalog. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLAzureVerifyRESTAPICertByLocation( String location ) ``` ### getSSLCRLMemSize() Get the size of the CRL shared memory. ```bash String getSSLCRLMemSize() ``` ### getSSLCRLMemSizeByLocation( location ) throws ObjectDoesNotExist Get the size of the CRL shared memory. This is a location specific function, any action will operate on the specified location. ```bash String getSSLCRLMemSizeByLocation( String location ) ``` ### getSSLCipherSuites() Get the SSL/TLS cipher suites preference list for SSL/TLS connections unless overridden by virtual server or pool settings ```bash String getSSLCipherSuites() ``` ### getSSLCipherSuitesByLocation( location ) throws ObjectDoesNotExist Get the SSL/TLS cipher suites preference list for SSL/TLS connections unless overridden by virtual server or pool settings This is a location specific function, any action will operate on the specified location. ```bash String getSSLCipherSuitesByLocation( String location ) ``` ### getSSLClientCacheEnabled() Get whether the SSL client cache will be used, unless overridden by pool settings. ```bash Boolean getSSLClientCacheEnabled() ``` ### getSSLClientCacheEnabledByLocation( location ) throws ObjectDoesNotExist Get whether the SSL client cache will be used, unless overridden by pool settings. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLClientCacheEnabledByLocation( String location ) ``` ### getSSLClientCacheExpiry() Get the length of time that SSL sessions are stored in the client cache (for SSL encryption), in seconds. ```bash Unsigned Integer getSSLClientCacheExpiry() ``` ### getSSLClientCacheExpiryByLocation( location ) throws ObjectDoesNotExist Get the length of time that SSL sessions are stored in the client cache (for SSL encryption), in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLClientCacheExpiryByLocation( String location ) ``` ### getSSLClientCacheSize() Get the number of entries in the SSL encryption session cache. ```bash Unsigned Integer getSSLClientCacheSize() ``` ### getSSLClientCacheSizeByLocation( location ) throws ObjectDoesNotExist Get the number of entries in the SSL encryption session cache. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLClientCacheSizeByLocation( String location ) ``` ### getSSLClientTicketsEnabled() Get whether session tickets may be requested and stored in the SSL client cache. ```bash Boolean getSSLClientTicketsEnabled() ``` ### getSSLClientTicketsEnabledByLocation( location ) throws ObjectDoesNotExist Get whether session tickets may be requested and stored in the SSL client cache. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLClientTicketsEnabledByLocation( String location ) ``` ### getSSLDFailureCount() getSSLDFailureCount is deprecated, please use getSSLHardwareFailureCount instead. ```bash Unsigned Integer getSSLDFailureCount() ``` ### getSSLDFailureCountByLocation( location ) throws ObjectDoesNotExist getSSLDFailureCount is deprecated, please use getSSLHardwareFailureCount instead. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLDFailureCountByLocation( String location ) ``` ### getSSLDPKCS11Lib() getSSLDPKCS11Lib is deprecated, please use getSSLHardwarePKCS11Lib instead. ```bash String getSSLDPKCS11Lib() ``` ### getSSLDPKCS11LibByLocation( location ) throws ObjectDoesNotExist getSSLDPKCS11Lib is deprecated, please use getSSLHardwarePKCS11Lib instead. This is a location specific function, any action will operate on the specified location. ```bash String getSSLDPKCS11LibByLocation( String location ) ``` ### getSSLDiffieHellmanModulusSize() Get the number of bits to use for the finite field Diffie-Hellman modulus ```bash GlobalSettings.SSLDiffieHellmanModulusSize getSSLDiffieHellmanModulusSize() ``` ### getSSLDiffieHellmanModulusSizeByLocation( location ) throws ObjectDoesNotExist Get the number of bits to use for the finite field Diffie-Hellman modulus This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.SSLDiffieHellmanModulusSize getSSLDiffieHellmanModulusSizeByLocation( String location ) ``` ### getSSLEllipticCurves() Get the elliptic curve preference list for SSL/TLS connections unless overridden by virtual server or pool settings ```bash String getSSLEllipticCurves() ``` ### getSSLEllipticCurvesByLocation( location ) throws ObjectDoesNotExist Get the elliptic curve preference list for SSL/TLS connections unless overridden by virtual server or pool settings This is a location specific function, any action will operate on the specified location. ```bash String getSSLEllipticCurvesByLocation( String location ) ``` ### getSSLHardwareAccelerator() Get whether your traffic manager should always attempt to use SSL hardware. ```bash Boolean getSSLHardwareAccelerator() ``` ### getSSLHardwareAcceleratorByLocation( location ) throws ObjectDoesNotExist Get whether your traffic manager should always attempt to use SSL hardware. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLHardwareAcceleratorByLocation( String location ) ``` ### getSSLHardwareFailureCount() Get the number of consecutive failures from the SSL hardware that will be tolerated before your traffic manager tries to log in again. ```bash Unsigned Integer getSSLHardwareFailureCount() ``` ### getSSLHardwareFailureCountByLocation( location ) throws ObjectDoesNotExist Get the number of consecutive failures from the SSL hardware that will be tolerated before your traffic manager tries to log in again. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLHardwareFailureCountByLocation( String location ) ``` ### getSSLHardwarePKCS11Lib() Get the location of the PKCS#11 library supplied by your hardware vendor. ```bash String getSSLHardwarePKCS11Lib() ``` ### getSSLHardwarePKCS11LibByLocation( location ) throws ObjectDoesNotExist Get the location of the PKCS#11 library supplied by your hardware vendor. This is a location specific function, any action will operate on the specified location. ```bash String getSSLHardwarePKCS11LibByLocation( String location ) ``` ### getSSLHardwarePKCS11SlotLabel() Get the label of the SSL hardware slot to use. ```bash String getSSLHardwarePKCS11SlotLabel() ``` ### getSSLHardwarePKCS11SlotLabelByLocation( location ) throws ObjectDoesNotExist Get the label of the SSL hardware slot to use. This is a location specific function, any action will operate on the specified location. ```bash String getSSLHardwarePKCS11SlotLabelByLocation( String location ) ``` ### getSSLHardwarePKCS11SlotType() Get the type of PKCS11 slot to use. Only used for PKCS11. ```bash GlobalSettings.SSLHardwarePKCS11SlotType getSSLHardwarePKCS11SlotType() ``` ### getSSLHardwarePKCS11SlotTypeByLocation( location ) throws ObjectDoesNotExist Get the type of PKCS11 slot to use. Only used for PKCS11. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.SSLHardwarePKCS11SlotType getSSLHardwarePKCS11SlotTypeByLocation( String location ) ``` ### getSSLHardwareType() Get the device driver library name. ```bash GlobalSettings.SSLHardwareType getSSLHardwareType() ``` ### getSSLHardwareTypeByLocation( location ) throws ObjectDoesNotExist Get the device driver library name. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.SSLHardwareType getSSLHardwareTypeByLocation( String location ) ``` ### getSSLHonorFallbackSCSV() Get whether ssl-decrypting Virtual Servers honor the Fallback SCSV ```bash Boolean getSSLHonorFallbackSCSV() ``` ### getSSLHonorFallbackSCSVByLocation( location ) throws ObjectDoesNotExist Get whether ssl-decrypting Virtual Servers honor the Fallback SCSV This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLHonorFallbackSCSVByLocation( String location ) ``` ### getSSLInsertExtraFragment() Get whether SSL3 and TLS1 use one byte fragments ```bash Boolean getSSLInsertExtraFragment() ``` ### getSSLInsertExtraFragmentByLocation( location ) throws ObjectDoesNotExist Get whether SSL3 and TLS1 use one byte fragments This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLInsertExtraFragmentByLocation( String location ) ``` ### getSSLLogKeys() Get Whether SSL key logging should be available. ```bash Boolean getSSLLogKeys() ``` ### getSSLLogKeysByLocation( location ) throws ObjectDoesNotExist Get Whether SSL key logging should be available. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLLogKeysByLocation( String location ) ``` ### getSSLMaxHandshakeMessageSize() Get the maximum acceptable size (in bytes) a SSL handshake message is permitted to be. ```bash Unsigned Integer getSSLMaxHandshakeMessageSize() ``` ### getSSLMaxHandshakeMessageSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum acceptable size (in bytes) a SSL handshake message is permitted to be. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLMaxHandshakeMessageSizeByLocation( String location ) ``` ### getSSLMiddleboxCompatibility() Get whether TLS 1.3 middlebox compatibility mode will be used, unless overridden by pool settings. ```bash Boolean getSSLMiddleboxCompatibility() ``` ### getSSLMiddleboxCompatibilityByLocation( location ) throws ObjectDoesNotExist Get whether TLS 1.3 middlebox compatibility mode will be used, unless overridden by pool settings. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLMiddleboxCompatibilityByLocation( String location ) ``` ### getSSLMinRehandshakeInterval() Get the minimum time interval (in milliseconds) between handshakes on a single SSL3/TLS connection. ```bash Unsigned Integer getSSLMinRehandshakeInterval() ``` ### getSSLMinRehandshakeIntervalByLocation( location ) throws ObjectDoesNotExist Get the minimum time interval (in milliseconds) between handshakes on a single SSL3/TLS connection. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLMinRehandshakeIntervalByLocation( String location ) ``` ### getSSLOCSPStaplingDefaultRefreshInterval() Get how long to wait before refreshing requests on behalf of the store of certificate status responses used by OCSP stapling, if we don't have an up-to-date OCSP response. ```bash Unsigned Integer getSSLOCSPStaplingDefaultRefreshInterval() ``` ### getSSLOCSPStaplingDefaultRefreshIntervalByLocation( location ) throws ObjectDoesNotExist Get how long to wait before refreshing requests on behalf of the store of certificate status responses used by OCSP stapling, if we don't have an up-to-date OCSP response. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLOCSPStaplingDefaultRefreshIntervalByLocation( String location ) ``` ### getSSLOCSPStaplingMaximumRefreshInterval() Get maximum number of seconds to wait before refreshing requests on behalf of the store of certificate status responses used by OCSP stapling. (0 means no maximum.) ```bash Unsigned Integer getSSLOCSPStaplingMaximumRefreshInterval() ``` ### getSSLOCSPStaplingMaximumRefreshIntervalByLocation( location ) throws ObjectDoesNotExist Get maximum number of seconds to wait before refreshing requests on behalf of the store of certificate status responses used by OCSP stapling. (0 means no maximum.) This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLOCSPStaplingMaximumRefreshIntervalByLocation( String location ) ``` ### getSSLOCSPStaplingMemSize() Get the size of the OCSP stapling response shared memory. ```bash String getSSLOCSPStaplingMemSize() ``` ### getSSLOCSPStaplingMemSizeByLocation( location ) throws ObjectDoesNotExist Get the size of the OCSP stapling response shared memory. This is a location specific function, any action will operate on the specified location. ```bash String getSSLOCSPStaplingMemSizeByLocation( String location ) ``` ### getSSLOCSPStaplingTimeTolerance() Get how many seconds to allow the current time to be outside the validity time of an OCSP response before considering it invalid. ```bash Unsigned Integer getSSLOCSPStaplingTimeTolerance() ``` ### getSSLOCSPStaplingTimeToleranceByLocation( location ) throws ObjectDoesNotExist Get how many seconds to allow the current time to be outside the validity time of an OCSP response before considering it invalid. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLOCSPStaplingTimeToleranceByLocation( String location ) ``` ### getSSLOCSPStaplingVerifyResponse() Get whether to verify the OCSP response signature before caching a response for OCSP stapling. ```bash Boolean getSSLOCSPStaplingVerifyResponse() ``` ### getSSLOCSPStaplingVerifyResponseByLocation( location ) throws ObjectDoesNotExist Get whether to verify the OCSP response signature before caching a response for OCSP stapling. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLOCSPStaplingVerifyResponseByLocation( String location ) ``` ### getSSLPreventTimingSideChannels() This method is now obsolete ```bash Boolean getSSLPreventTimingSideChannels() ``` ### getSSLPreventTimingSideChannelsByLocation( location ) throws ObjectDoesNotExist This method is now obsolete ```bash Boolean getSSLPreventTimingSideChannelsByLocation( String location ) ``` ### getSSLSessionCachePerVirtualserver() Get whether an SSL session created by a given virtual server can only be resumed by a connection to the same virtual server. ```bash Boolean getSSLSessionCachePerVirtualserver() ``` ### getSSLSessionCachePerVirtualserverByLocation( location ) throws ObjectDoesNotExist Get whether an SSL session created by a given virtual server can only be resumed by a connection to the same virtual server. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLSessionCachePerVirtualserverByLocation( String location ) ``` ### getSSLSessionCacheSize() Get the maximum number of entries in the SSL session cache. This is used to provide persistence based on SSL session IDs. ```bash Unsigned Integer getSSLSessionCacheSize() ``` ### getSSLSessionCacheSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum number of entries in the SSL session cache. This is used to provide persistence based on SSL session IDs. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLSessionCacheSizeByLocation( String location ) ``` ### getSSLSessionIDCacheEnabled() Get whether the SSL server session cache is enabled, unless overridden by virtual server settings. ```bash Boolean getSSLSessionIDCacheEnabled() ``` ### getSSLSessionIDCacheEnabledByLocation( location ) throws ObjectDoesNotExist Get whether the SSL server session cache is enabled, unless overridden by virtual server settings. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLSessionIDCacheEnabledByLocation( String location ) ``` ### getSSLSessionIDCacheExpiryTime() Get the length of time that SSL session IDs are stored, in seconds. ```bash Unsigned Integer getSSLSessionIDCacheExpiryTime() ``` ### getSSLSessionIDCacheExpiryTimeByLocation( location ) throws ObjectDoesNotExist Get the length of time that SSL session IDs are stored, in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLSessionIDCacheExpiryTimeByLocation( String location ) ``` ### getSSLSessionIDCacheSize() Get the number of entries in the SSL session ID cache. ```bash Unsigned Integer getSSLSessionIDCacheSize() ``` ### getSSLSessionIDCacheSizeByLocation( location ) throws ObjectDoesNotExist Get the number of entries in the SSL session ID cache. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSSLSessionIDCacheSizeByLocation( String location ) ``` ### getSSLSignatureAlgorithms() Get the SSL/TLS signature algorithms preference list for SSL/TLS connections unless overridden by virtual server or pool settings ```bash String getSSLSignatureAlgorithms() ``` ### getSSLSignatureAlgorithmsByLocation( location ) throws ObjectDoesNotExist Get the SSL/TLS signature algorithms preference list for SSL/TLS connections unless overridden by virtual server or pool settings This is a location specific function, any action will operate on the specified location. ```bash String getSSLSignatureAlgorithmsByLocation( String location ) ``` ### getSSLSupportSSL2() This method is now deprecated. ```bash Boolean getSSLSupportSSL2() ``` ### getSSLSupportSSL2ByLocation( location ) throws ObjectDoesNotExist This method is now deprecated. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLSupportSSL2ByLocation( String location ) ``` ### getSSLSupportSSL3() Get whether SSLv3 support is enabled. ```bash Boolean getSSLSupportSSL3() ``` ### getSSLSupportSSL3ByLocation( location ) throws ObjectDoesNotExist Get whether SSLv3 support is enabled. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLSupportSSL3ByLocation( String location ) ``` ### getSSLSupportTLS1() Get whether TLSv1 support is enabled. ```bash Boolean getSSLSupportTLS1() ``` ### getSSLSupportTLS11() Get whether TLSv1.1 support is enabled. ```bash Boolean getSSLSupportTLS11() ``` ### getSSLSupportTLS11ByLocation( location ) throws ObjectDoesNotExist Get whether TLSv1.1 support is enabled. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLSupportTLS11ByLocation( String location ) ``` ### getSSLSupportTLS12() Get whether TLSv1.2 support is enabled. ```bash Boolean getSSLSupportTLS12() ``` ### getSSLSupportTLS12ByLocation( location ) throws ObjectDoesNotExist Get whether TLSv1.2 support is enabled. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLSupportTLS12ByLocation( String location ) ``` ### getSSLSupportTLS13() Get whether TLSv1.3 support is enabled. ```bash Boolean getSSLSupportTLS13() ``` ### getSSLSupportTLS13ByLocation( location ) throws ObjectDoesNotExist Get whether TLSv1.3 support is enabled. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLSupportTLS13ByLocation( String location ) ``` ### getSSLSupportTLS1ByLocation( location ) throws ObjectDoesNotExist Get whether TLSv1 support is enabled. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLSupportTLS1ByLocation( String location ) ``` ### getSSLTicketsEnabled() Get whether use of session tickets is enabled, unless overridden by virtual server settings. ```bash Boolean getSSLTicketsEnabled() ``` ### getSSLTicketsEnabledByLocation( location ) throws ObjectDoesNotExist Get whether use of session tickets is enabled, unless overridden by virtual server settings. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLTicketsEnabledByLocation( String location ) ``` ### getSSLTicketsReissuePolicy() Get the SSL tickets reissue policy ```bash GlobalSettings.SSLTicketsReissuePolicy getSSLTicketsReissuePolicy() ``` ### getSSLTicketsTicketExpiry() Get the length of time for which an SSL session ticket will be accepted by a virtual server after the ticket is created. ```bash Unsigned Integer getSSLTicketsTicketExpiry() ``` ### getSSLTicketsTicketKeyExpiry() Get the length of time for which an auto-generated SSL ticket key will be used to decrypt old session tickets. ```bash Unsigned Integer getSSLTicketsTicketKeyExpiry() ``` ### getSSLTicketsTicketKeyRotation() Get the length of time for which an auto-generated SSL ticket key will be used to encrypt new session tickets. ```bash Unsigned Integer getSSLTicketsTicketKeyRotation() ``` ### getSSLTicketsTimeTolerance() Get the number of seconds to allow the current time to be outside the validity time of an SSL ticket before considering it invalid. ```bash Unsigned Integer getSSLTicketsTimeTolerance() ``` ### getSSLValidateServerCertificatesCatalog() Get whether SSL server certificates are validated. ```bash Boolean getSSLValidateServerCertificatesCatalog() ``` ### getSSLValidateServerCertificatesCatalogByLocation( location ) throws ObjectDoesNotExist Get whether SSL server certificates are validated. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSSLValidateServerCertificatesCatalogByLocation( String location ) ``` ### getSharedPoolSize() Get is the size of shared memory pool to be used for shared storage across worker processes. ```bash String getSharedPoolSize() ``` ### getSharedPoolSizeByLocation( location ) throws ObjectDoesNotExist Get is the size of shared memory pool to be used for shared storage across worker processes. This is a location specific function, any action will operate on the specified location. ```bash String getSharedPoolSizeByLocation( String location ) ``` ### getSoapIdleMinutes() Get the number of minutes the SOAP server remain idle before exiting ```bash Unsigned Integer getSoapIdleMinutes() ``` ### getSoapIdleMinutesByLocation( location ) throws ObjectDoesNotExist Get the number of minutes the SOAP server remain idle before exiting This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSoapIdleMinutesByLocation( String location ) ``` ### getSocketOptimizations() Get whether potential network socket optimisations should be used. ```bash GlobalSettings.SocketOptimizations getSocketOptimizations() ``` ### getSocketOptimizationsByLocation( location ) throws ObjectDoesNotExist Get whether potential network socket optimisations should be used. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.SocketOptimizations getSocketOptimizationsByLocation( String location ) ``` ### getSsldAccel() getSsldAccel is deprecated, please use getSSLHardwareAccelerator instead. ```bash Boolean getSsldAccel() ``` ### getSsldAccelByLocation( location ) throws ObjectDoesNotExist getSsldAccel is deprecated, please use getSSLHardwareAccelerator instead. This is a location specific function, any action will operate on the specified location. ```bash Boolean getSsldAccelByLocation( String location ) ``` ### getSsldLibrary() getSsldLibrary is deprecated, please use getSSLHardwareType instead. ```bash GlobalSettings.SsldLibrary getSsldLibrary() ``` ### getSsldLibraryByLocation( location ) throws ObjectDoesNotExist getSsldLibrary is deprecated, please use getSSLHardwareType instead. This is a location specific function, any action will operate on the specified location. ```bash GlobalSettings.SsldLibrary getSsldLibraryByLocation( String location ) ``` ### getStateSyncTime() Get how often the cache state is propagated to other traffic managers in the cluster, in seconds. ```bash Unsigned Integer getStateSyncTime() ``` ### getStateSyncTimeByLocation( location ) throws ObjectDoesNotExist Get how often the cache state is propagated to other traffic managers in the cluster, in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getStateSyncTimeByLocation( String location ) ``` ### getStateSyncTimeout() Get the timeout for state propagation between cluster members, in seconds ```bash Unsigned Integer getStateSyncTimeout() ``` ### getStateSyncTimeoutByLocation( location ) throws ObjectDoesNotExist Get the timeout for state propagation between cluster members, in seconds This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getStateSyncTimeoutByLocation( String location ) ``` ### getSystemReadBufferSize() Get the size of the operating system's read buffer, in bytes (0 means use the system default). ```bash Unsigned Integer getSystemReadBufferSize() ``` ### getSystemReadBufferSizeByLocation( location ) throws ObjectDoesNotExist Get the size of the operating system's read buffer, in bytes (0 means use the system default). This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSystemReadBufferSizeByLocation( String location ) ``` ### getSystemWriteBufferSize() Get the size of the operating system's write buffer, in bytes (0 means use the system default). ```bash Unsigned Integer getSystemWriteBufferSize() ``` ### getSystemWriteBufferSizeByLocation( location ) throws ObjectDoesNotExist Get the size of the operating system's write buffer, in bytes (0 means use the system default). This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getSystemWriteBufferSizeByLocation( String location ) ``` ### getTelemetryEnabled() Get allow the reporting of anonymized usage data for product improvement and customer support purposes. ```bash Boolean getTelemetryEnabled() ``` ### getTelemetryEnabledByLocation( location ) throws ObjectDoesNotExist Get allow the reporting of anonymized usage data for product improvement and customer support purposes. This is a location specific function, any action will operate on the specified location. ```bash Boolean getTelemetryEnabledByLocation( String location ) ``` ### getTrackUnknownUsers() Get whether to remember past login attempts from usernames that are not known to exist (should be No for an Admin Server accessible from the public Internet). ```bash Boolean getTrackUnknownUsers() ``` ### getTrafficIPGroupLimit() Get the maximum number of Traffic IP Groups allowed. ```bash Unsigned Integer getTrafficIPGroupLimit() ``` ### getTrafficIPGroupLimitByLocation( location ) throws ObjectDoesNotExist Get the maximum number of Traffic IP Groups allowed. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getTrafficIPGroupLimitByLocation( String location ) ``` ### getTrafficScriptExecutionTimeWarning() Get the number of milliseconds a rule can run for before a warning is logged. ```bash Unsigned Integer getTrafficScriptExecutionTimeWarning() ``` ### getTrafficScriptExecutionTimeWarningByLocation( location ) throws ObjectDoesNotExist Get the number of milliseconds a rule can run for before a warning is logged. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getTrafficScriptExecutionTimeWarningByLocation( String location ) ``` ### getTrafficScriptMemoryWarning() Get the amount of buffered network data a TrafficScript rule can buffer before a warning is logged, in bytes. ```bash Unsigned Integer getTrafficScriptMemoryWarning() ``` ### getTrafficScriptMemoryWarningByLocation( location ) throws ObjectDoesNotExist Get the amount of buffered network data a TrafficScript rule can buffer before a warning is logged, in bytes. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getTrafficScriptMemoryWarningByLocation( String location ) ``` ### getTrafficscriptArrayElements() This method is now obsolete. ```bash Unsigned Integer getTrafficscriptArrayElements() ``` ### getTrafficscriptArrayElementsByLocation( location ) throws ObjectDoesNotExist This method is now obsolete. ```bash Unsigned Integer getTrafficscriptArrayElementsByLocation( String location ) ``` ### getTrafficscriptDataLocalSize() Get the maximum size of the TrafficScript local data pool (specified as a percentage of system RAM, e.g. '5%', or an absolute size, e.g. 200MB) ```bash String getTrafficscriptDataLocalSize() ``` ### getTrafficscriptDataLocalSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum size of the TrafficScript local data pool (specified as a percentage of system RAM, e.g. '5%', or an absolute size, e.g. 200MB) This is a location specific function, any action will operate on the specified location. ```bash String getTrafficscriptDataLocalSizeByLocation( String location ) ``` ### getTrafficscriptDataSize() Get the maximum size of the TrafficScript shared data pool (specified as a percentage of system RAM, e.g. '5%', or an absolute size, e.g. 200MB) ```bash String getTrafficscriptDataSize() ``` ### getTrafficscriptDataSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum size of the TrafficScript shared data pool (specified as a percentage of system RAM, e.g. '5%', or an absolute size, e.g. 200MB) This is a location specific function, any action will operate on the specified location. ```bash String getTrafficscriptDataSizeByLocation( String location ) ``` ### getTrafficscriptMaxInstr() Get the maximum number of instructions a TrafficScript rule will run before being aborted. ```bash Unsigned Integer getTrafficscriptMaxInstr() ``` ### getTrafficscriptMaxInstrByLocation( location ) throws ObjectDoesNotExist Get the maximum number of instructions a TrafficScript rule will run before being aborted. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getTrafficscriptMaxInstrByLocation( String location ) ``` ### getTrafficscriptRegexCacheSize() Get the number of regular expressions to cache ```bash Unsigned Integer getTrafficscriptRegexCacheSize() ``` ### getTrafficscriptRegexCacheSizeByLocation( location ) throws ObjectDoesNotExist Get the number of regular expressions to cache This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getTrafficscriptRegexCacheSizeByLocation( String location ) ``` ### getTrafficscriptRegexMatchLimit() Get the maximum number of ways TrafficScript will attempt to match a regular expression at each position in the subject string, before it aborts the rule and reports a TrafficScript error. ```bash Unsigned Integer getTrafficscriptRegexMatchLimit() ``` ### getTrafficscriptRegexMatchLimitByLocation( location ) throws ObjectDoesNotExist Get the maximum number of ways TrafficScript will attempt to match a regular expression at each position in the subject string, before it aborts the rule and reports a TrafficScript error. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getTrafficscriptRegexMatchLimitByLocation( String location ) ``` ### getTrafficscriptRegexMatchWarnPerc() Get the percentage of trafficscript!regex\_match\_limit at which TrafficScript reports a performance warning. ```bash Unsigned Integer getTrafficscriptRegexMatchWarnPerc() ``` ### getTrafficscriptRegexMatchWarnPercByLocation( location ) throws ObjectDoesNotExist Get the percentage of trafficscript!regex\_match\_limit at which TrafficScript reports a performance warning. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getTrafficscriptRegexMatchWarnPercByLocation( String location ) ``` ### getTrafficscriptVariablePoolUse() Get whether the 'pool.use' and 'pool.select' TrafficScript functions accept variables as well as literal strings. ```bash Boolean getTrafficscriptVariablePoolUse() ``` ### getTrafficscriptVariablePoolUseByLocation( location ) throws ObjectDoesNotExist Get whether the 'pool.use' and 'pool.select' TrafficScript functions accept variables as well as literal strings. This is a location specific function, any action will operate on the specified location. ```bash Boolean getTrafficscriptVariablePoolUseByLocation( String location ) ``` ### getTransactionExportEnabled() Get whether to export metadata about transactions processed by the traffic manager to an external location. ```bash Boolean getTransactionExportEnabled() ``` ### getTransactionExportEnabledByLocation( location ) throws ObjectDoesNotExist Get whether to export metadata about transactions processed by the traffic manager to an external location. This is a location specific function, any action will operate on the specified location. ```bash Boolean getTransactionExportEnabledByLocation( String location ) ``` ### getTransactionExportEndpoint() Get the endpoint to which transaction metadata should be exported. ```bash String getTransactionExportEndpoint() ``` ### getTransactionExportEndpointByLocation( location ) throws ObjectDoesNotExist Get the endpoint to which transaction metadata should be exported. This is a location specific function, any action will operate on the specified location. ```bash String getTransactionExportEndpointByLocation( String location ) ``` ### getTransactionExportTLS() Get whether the connection to the specified endpoint should be encrypted. ```bash Boolean getTransactionExportTLS() ``` ### getTransactionExportTLSByLocation( location ) throws ObjectDoesNotExist Get whether the connection to the specified endpoint should be encrypted. This is a location specific function, any action will operate on the specified location. ```bash Boolean getTransactionExportTLSByLocation( String location ) ``` ### getTransactionExportTLSVerify() Get whether the server certificate presented by the endpoint should be verified, preventing a connection from being established if the certificate does not match the server name, is self-signed, is expired, is revoked, or has an unknown CA. ```bash Boolean getTransactionExportTLSVerify() ``` ### getTransactionExportTLSVerifyByLocation( location ) throws ObjectDoesNotExist Get whether the server certificate presented by the endpoint should be verified, preventing a connection from being established if the certificate does not match the server name, is self-signed, is expired, is revoked, or has an unknown CA. This is a location specific function, any action will operate on the specified location. ```bash Boolean getTransactionExportTLSVerifyByLocation( String location ) ``` ### getUDPReadMultiple() Get whether your traffic manager should try to read multiple UDP packets from clients each time the kernel reports data received from clients. ```bash Boolean getUDPReadMultiple() ``` ### getUDPReadMultipleByLocation( location ) throws ObjectDoesNotExist Get whether your traffic manager should try to read multiple UDP packets from clients each time the kernel reports data received from clients. This is a location specific function, any action will operate on the specified location. ```bash Boolean getUDPReadMultipleByLocation( String location ) ``` ### getUipageBanner() Get the banner text to be displayed on all Admin Server pages. ```bash String getUipageBanner() ``` ### getUniversalSessionCacheExpiry() Get universal session cache expiry time in seconds. ```bash Unsigned Integer getUniversalSessionCacheExpiry() ``` ### getUniversalSessionCacheExpiryByLocation( location ) throws ObjectDoesNotExist Get universal session cache expiry time in seconds. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getUniversalSessionCacheExpiryByLocation( String location ) ``` ### getUniversalSessionCacheSize() Get the maximum number of entries in the universal session cache. ```bash Unsigned Integer getUniversalSessionCacheSize() ``` ### getUniversalSessionCacheSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum number of entries in the universal session cache. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getUniversalSessionCacheSizeByLocation( String location ) ``` ### getWatchdogTimeout() Get the maximum time in seconds a process can fail to update its heartbeat, before the watchdog considers it to have stalled. ```bash Unsigned Integer getWatchdogTimeout() ``` ### getWatchdogTimeoutByLocation( location ) throws ObjectDoesNotExist Get the maximum time in seconds a process can fail to update its heartbeat, before the watchdog considers it to have stalled. This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getWatchdogTimeoutByLocation( String location ) ``` ### getWebcacheAvgPathLength() Get the estimated average length of the path for resources to be cached ```bash Unsigned Integer getWebcacheAvgPathLength() ``` ### getWebcacheAvgPathLengthByLocation( location ) throws ObjectDoesNotExist Get the estimated average length of the path for resources to be cached This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getWebcacheAvgPathLengthByLocation( String location ) ``` ### getWebcacheDisk() Get whether the webcache is stored on disk ```bash Boolean getWebcacheDisk() ``` ### getWebcacheDiskByLocation( location ) throws ObjectDoesNotExist Get whether the webcache is stored on disk This is a location specific function, any action will operate on the specified location. ```bash Boolean getWebcacheDiskByLocation( String location ) ``` ### getWebcacheDiskDir() Get the disk cache location ```bash String getWebcacheDiskDir() ``` ### getWebcacheDiskDirByLocation( location ) throws ObjectDoesNotExist Get the disk cache location This is a location specific function, any action will operate on the specified location. ```bash String getWebcacheDiskDirByLocation( String location ) ``` ### getWebcacheMaxFileNum() Get the maximum number of files that can be stored in the web cache ```bash Unsigned Integer getWebcacheMaxFileNum() ``` ### getWebcacheMaxFileNumByLocation( location ) throws ObjectDoesNotExist Get the maximum number of files that can be stored in the web cache This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getWebcacheMaxFileNumByLocation( String location ) ``` ### getWebcacheMaxFileSize() Get the largest size of a cacheable object, relative to the total cache size, e.g. '2%', or as an absolute size in kB (default), MB or GB, e.g. '20MB'. ```bash String getWebcacheMaxFileSize() ``` ### getWebcacheMaxFileSizeByLocation( location ) throws ObjectDoesNotExist Get the largest size of a cacheable object, relative to the total cache size, e.g. '2%', or as an absolute size in kB (default), MB or GB, e.g. '20MB'. This is a location specific function, any action will operate on the specified location. ```bash String getWebcacheMaxFileSizeByLocation( String location ) ``` ### getWebcacheMaxPathLength() Get the maximum length of the path for the resource being cached ```bash Unsigned Integer getWebcacheMaxPathLength() ``` ### getWebcacheMaxPathLengthByLocation( location ) throws ObjectDoesNotExist Get the maximum length of the path for the resource being cached This is a location specific function, any action will operate on the specified location. ```bash Unsigned Integer getWebcacheMaxPathLengthByLocation( String location ) ``` ### getWebcacheNormalizeQuery() Get whether the assignment sub-strings in the parameter string are put into alphabetical order. ```bash Boolean getWebcacheNormalizeQuery() ``` ### getWebcacheNormalizeQueryByLocation( location ) throws ObjectDoesNotExist Get whether the assignment sub-strings in the parameter string are put into alphabetical order. This is a location specific function, any action will operate on the specified location. ```bash Boolean getWebcacheNormalizeQueryByLocation( String location ) ``` ### getWebcacheSize() Get the maximum size of the HTTP web page cache, (specified as a percentage of system RAM, e.g. '20%', or an absolute size, e.g. 200MB) ```bash String getWebcacheSize() ``` ### getWebcacheSizeByLocation( location ) throws ObjectDoesNotExist Get the maximum size of the HTTP web page cache, (specified as a percentage of system RAM, e.g. '20%', or an absolute size, e.g. 200MB) This is a location specific function, any action will operate on the specified location. ```bash String getWebcacheSizeByLocation( String location ) ``` ### getWebcacheVerbose() Get whether an X-Cache-Info header to show cacheability should be added. ```bash Boolean getWebcacheVerbose() ``` ### getWebcacheVerboseByLocation( location ) throws ObjectDoesNotExist Get whether an X-Cache-Info header to show cacheability should be added. This is a location specific function, any action will operate on the specified location. ```bash Boolean getWebcacheVerboseByLocation( String location ) ``` ### removeApplianceReturnPathRoutes( value ) throws InvalidInput, DeploymentError Remove a set of return path routes (MAC/IP mappings) from the configuration. ```bash void removeApplianceReturnPathRoutes( GlobalSettings.ReturnPathRoute[] value ) ``` ### removeApplianceReturnPathRoutesByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Remove a set of return path routes (MAC/IP mappings) from the configuration. This is a location specific function, any action will operate on the specified location. ```bash void removeApplianceReturnPathRoutesByLocation( String location GlobalSettings.ReturnPathRoute[] value ) ``` ### removeFlipperFrontendCheckAddresses( values ) throws InvalidInput, DeploymentError Remove IP addresses from the list that should be used to check front-end connectivity ```bash void removeFlipperFrontendCheckAddresses( String[] values ) ``` ### removeFlipperFrontendCheckAddressesByLocation( location, values ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Remove IP addresses from the list that should be used to check front-end connectivity This is a location specific function, any action will operate on the specified location. ```bash void removeFlipperFrontendCheckAddressesByLocation( String location String[] values ) ``` ### removeLicenseServers( values ) Remove A list of license servers for FLA licensing. ```bash void removeLicenseServers( String[] values ) ``` ### removeLicenseServersByLocation( location, values ) throws ObjectDoesNotExist Remove A list of license servers for FLA licensing. This is a location specific function, any action will operate on the specified location. ```bash void removeLicenseServersByLocation( String location String[] values ) ``` ### setASPSessionCacheSize( value ) throws InvalidInput, DeploymentError Set the maximum number of entries in the ASP session cache. ```bash void setASPSessionCacheSize( Unsigned Integer value ) ``` ### setASPSessionCacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of entries in the ASP session cache. This is a location specific function, any action will operate on the specified location. ```bash void setASPSessionCacheSizeByLocation( String location Unsigned Integer value ) ``` ### setAcceptingDelay( value ) throws InvalidInput, DeploymentError Set how often each traffic manager child process checks whether it should be accepting new connections. ```bash void setAcceptingDelay( Unsigned Integer value ) ``` ### setAcceptingDelayByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set how often each traffic manager child process checks whether it should be accepting new connections. This is a location specific function, any action will operate on the specified location. ```bash void setAcceptingDelayByLocation( String location Unsigned Integer value ) ``` ### setAdminAllowRehandshake( value ) throws InvalidInput, DeploymentError Set whether SSL / TLS re-handshakes are supported. ```bash void setAdminAllowRehandshake( GlobalSettings.AdminAllowRehandshake value ) ``` ### setAdminDiffieHellmanKeyLength( value ) throws InvalidInput, DeploymentError Set the number of bits to use for Diffie-Hellman keys ```bash void setAdminDiffieHellmanKeyLength( GlobalSettings.AdminDiffieHellmanKeyLength value ) ``` ### setAdminHonorFallbackSCSV( value ) throws InvalidInput, DeploymentError Set whether admin server, internal control port and config daemon honor the Fallback SCSV ```bash void setAdminHonorFallbackSCSV( Boolean value ) ``` ### setAdminInsertExtraFragment( value ) throws InvalidInput, DeploymentError Set whether admin server SSL3 and TLS1 use one byte fragments ```bash void setAdminInsertExtraFragment( Boolean value ) ``` ### setAdminMinRehandshakeInterval( value ) throws InvalidInput, DeploymentError Set the minimum time interval (in milliseconds) between handshakes on a single SSL3/TLS connection. ```bash void setAdminMinRehandshakeInterval( Unsigned Integer value ) ``` ### setAdminSSLCiphers( value ) throws InvalidInput, DeploymentError Set the list of configured SSL ciphers for admin server and internal connections (available ciphers can be displayed using the command $ZEUSHOME/zxtm/bin/zeus.zxtm -s). ```bash void setAdminSSLCiphers( String value ) ``` ### setAdminSSLEllipticCurves( value ) throws InvalidInput, DeploymentError Set the elliptic curve preference list for SSL connections to the admin server and within the traffic manager cluster. ```bash void setAdminSSLEllipticCurves( String value ) ``` ### setAdminSSLMaxHandshakeMessageSize( value ) throws InvalidInput, DeploymentError Set the maximum acceptable size (in bytes) a SSL handshake message is permitted to be for admin and internal connections. ```bash void setAdminSSLMaxHandshakeMessageSize( Unsigned Integer value ) ``` ### setAdminSSLPreventTimingSideChannels( value ) throws InvalidInput, DeploymentError Set an obsolete config value that has no effect. ```bash void setAdminSSLPreventTimingSideChannels( Boolean value ) ``` ### setAdminSSLSignatureAlgorithms( value ) throws InvalidInput, DeploymentError Set the SSL signature algorithms preference list for SSL connections to the admin server and within the zxtm cluster. ```bash void setAdminSSLSignatureAlgorithms( String value ) ``` ### setAdminSSLSupportTLS11( value ) throws InvalidInput, DeploymentError Set whether TLSv1.1 support is enabled for admin server and internal connections. ```bash void setAdminSSLSupportTLS11( Boolean value ) ``` ### setAdminSSLSupportTLS12( value ) throws InvalidInput, DeploymentError Set whether TLSv1.2 support is enabled for admin server and internal connections. ```bash void setAdminSSLSupportTLS12( Boolean value ) ``` ### setAdminSSLSupportTLS13( value ) throws InvalidInput, DeploymentError Set whether TLSv1.3 support is enabled for admin server and internal connections. ```bash void setAdminSSLSupportTLS13( Boolean value ) ``` ### setAdminSupportSSL2( value ) throws InvalidInput, DeploymentError This method is now deprecated. ```bash void setAdminSupportSSL2( Boolean value ) ``` ### setAdminSupportSSL3( value ) throws InvalidInput, DeploymentError Set whether SSLv3 support is enabled for admin server and internal connections. ```bash void setAdminSupportSSL3( Boolean value ) ``` ### setAdminSupportTLS1( value ) throws InvalidInput, DeploymentError Set whether TLSv1 support is enabled for admin server and internal connections. ```bash void setAdminSupportTLS1( Boolean value ) ``` ### setAfmEnabled( value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist, LicenseError Set whether the Web Application Firewall is enabled ```bash void setAfmEnabled( Boolean value ) ``` ### setAlertEmailInterval( value ) throws InvalidInput, DeploymentError Set the length of time between alert emails, in seconds. Several alert messages will be stored up and sent in one email. ```bash void setAlertEmailInterval( Unsigned Integer value ) ``` ### setAlertEmailIntervalByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the length of time between alert emails, in seconds. Several alert messages will be stored up and sent in one email. This is a location specific function, any action will operate on the specified location. ```bash void setAlertEmailIntervalByLocation( String location Unsigned Integer value ) ``` ### setAlertEmailMaxAttempts( value ) throws InvalidInput, DeploymentError Set the number of times to attempt sending an email before giving up. ```bash void setAlertEmailMaxAttempts( Unsigned Integer value ) ``` ### setAlertEmailMaxAttemptsByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of times to attempt sending an email before giving up. This is a location specific function, any action will operate on the specified location. ```bash void setAlertEmailMaxAttemptsByLocation( String location Unsigned Integer value ) ``` ### setAllowConsecutiveChars( value ) throws InvalidInput, DeploymentError Set whether the same character can appear consecutively in passwords. ```bash void setAllowConsecutiveChars( Boolean value ) ``` ### setApplianceReturnPathRoutes( value ) throws InvalidInput, DeploymentError Replace the configuration with the specified set of return path routes (MAC/IP mappings). ```bash void setApplianceReturnPathRoutes( GlobalSettings.ReturnPathRoute[] value ) ``` ### setApplianceReturnPathRoutesByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Replace the configuration with the specified set of return path routes (MAC/IP mappings). This is a location specific function, any action will operate on the specified location. ```bash void setApplianceReturnPathRoutesByLocation( String location GlobalSettings.ReturnPathRoute[] value ) ``` ### setApplianceReturnPathRoutingEnabled( value ) throws InvalidInput, DeploymentError Set whether return path routing is enabled ```bash void setApplianceReturnPathRoutingEnabled( Boolean value ) ``` ### setApplianceReturnPathRoutingEnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether return path routing is enabled This is a location specific function, any action will operate on the specified location. ```bash void setApplianceReturnPathRoutingEnabledByLocation( String location Boolean value ) ``` ### setAptimizerMaxDependentFetchSize( value ) throws InvalidInput, DeploymentError Set the maximum size of a dependent resource that can be sent to Web Accelerator. Set to 0 to disable limit. ```bash void setAptimizerMaxDependentFetchSize( String value ) ``` ### setAptimizerMaxOriginalContentBufferSize( value ) throws InvalidInput, DeploymentError Set the maximum size of original content buffer for content sent to Web Accelerator. ```bash void setAptimizerMaxOriginalContentBufferSize( String value ) ``` ### setAptimizerWatchdogInterval( value ) throws InvalidInput, DeploymentError Set How long (in seconds) the Web Accelerator watchdog mechanism should keep count of crashes for. ```bash void setAptimizerWatchdogInterval( Unsigned Integer value ) ``` ### setAptimizerWatchdogLimit( value ) throws InvalidInput, DeploymentError Set the maximum number of times the Web Accelerator sub-process will be restarted. ```bash void setAptimizerWatchdogLimit( Unsigned Integer value ) ``` ### setAuditlogViaEventd( value ) throws InvalidInput, DeploymentError Set whether the auditlog is to be mirrored to EventD. ```bash void setAuditlogViaEventd( Boolean value ) ``` ### setAuditlogViaEventdByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the auditlog is to be mirrored to EventD. This is a location specific function, any action will operate on the specified location. ```bash void setAuditlogViaEventdByLocation( String location Boolean value ) ``` ### setAuditlogViaSyslog( value ) throws InvalidInput, DeploymentError Set whether the auditlog is to be mirrored to the syslog ```bash void setAuditlogViaSyslog( Boolean value ) ``` ### setAuditlogViaSyslogByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the auditlog is to be mirrored to the syslog This is a location specific function, any action will operate on the specified location. ```bash void setAuditlogViaSyslogByLocation( String location Boolean value ) ``` ### setAuthSamlKeyLifetime( value ) throws InvalidInput, DeploymentError Set the lifetime of keys used to encrypt SAML SP session stored externally ```bash void setAuthSamlKeyLifetime( Unsigned Integer value ) ``` ### setAuthSamlKeyRotationInterval( value ) throws InvalidInput, DeploymentError Set the rotation interval of keys used to encrypt SAML SP session stored externally ```bash void setAuthSamlKeyRotationInterval( Unsigned Integer value ) ``` ### setAutoscalerVerbose( value ) throws InvalidInput, DeploymentError Set detailed logging of autoscaler status and actions ```bash void setAutoscalerVerbose( Boolean value ) ``` ### setAutoscalerVerboseByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set detailed logging of autoscaler status and actions This is a location specific function, any action will operate on the specified location. ```bash void setAutoscalerVerboseByLocation( String location Boolean value ) ``` ### setBackendKeepaliveTimeout( value ) throws InvalidInput, DeploymentError setBackendKeepaliveTimeout is deprecated, please use setIdleConnectionTimeout instead. ```bash void setBackendKeepaliveTimeout( Unsigned Integer value ) ``` ### setBackendKeepaliveTimeoutByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist setBackendKeepaliveTimeout is deprecated, please use setIdleConnectionTimeout instead. This is a location specific function, any action will operate on the specified location. ```bash void setBackendKeepaliveTimeoutByLocation( String location Unsigned Integer value ) ``` ### setBandwidthSharing( value ) throws InvalidInput, DeploymentError This method is now obsolete and is replaced by Catalog.Bandwidth.setSharing. ```bash void setBandwidthSharing( Boolean value ) ``` ### setBannerAccept( value ) throws InvalidInput, DeploymentError Set whether or not users must explicitly agree to the displayed login\_banner text before logging in to the Admin Server. ```bash void setBannerAccept( Boolean value ) ``` ### setBgpAsNumber( value ) throws InvalidInput, DeploymentError Set the number of the BGP AS in which the traffic manager will operate. ```bash void setBgpAsNumber( Unsigned Integer value ) ``` ### setBgpAsNumberByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of the BGP AS in which the traffic manager will operate. This is a location specific function, any action will operate on the specified location. ```bash void setBgpAsNumberByLocation( String location Unsigned Integer value ) ``` ### setBgpEnabled( value ) throws InvalidInput, DeploymentError Set whether BGP Route Health Injection is enabled. ```bash void setBgpEnabled( Boolean value ) ``` ### setBgpEnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether BGP Route Health Injection is enabled. This is a location specific function, any action will operate on the specified location. ```bash void setBgpEnabledByLocation( String location Boolean value ) ``` ### setBootloaderPassword( password ) throws InvalidInput, DeploymentError Set the bootloader password. ```bash void setBootloaderPassword( String password ) ``` ### setChunkSize( value ) throws InvalidInput, DeploymentError Set the default chunk size for reading and writing data, in bytes. ```bash void setChunkSize( Unsigned Integer value ) ``` ### setChunkSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the default chunk size for reading and writing data, in bytes. This is a location specific function, any action will operate on the specified location. ```bash void setChunkSizeByLocation( String location Unsigned Integer value ) ``` ### setClientFirstOpt( value ) throws InvalidInput, DeploymentError Set whether client-first network socket optimisations should be used. ```bash void setClientFirstOpt( Boolean value ) ``` ### setClientFirstOptByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether client-first network socket optimisations should be used. This is a location specific function, any action will operate on the specified location. ```bash void setClientFirstOptByLocation( String location Boolean value ) ``` ### setControlAllowHosts( value ) throws InvalidInput, DeploymentError Set the hosts that are allowed to contact the internal administration port on each traffic manager. ```bash void setControlAllowHosts( String value ) ``` ### setControlAllowHostsByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the hosts that are allowed to contact the internal administration port on each traffic manager. This is a location specific function, any action will operate on the specified location. ```bash void setControlAllowHostsByLocation( String location String value ) ``` ### setControlCanUpdateDefault( value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the value of the control!canupdate key for new cluster members. ```bash void setControlCanUpdateDefault( Boolean value ) ``` ### setDNSCacheExpiryTime( value ) throws InvalidInput, DeploymentError This method is now deprecated and is replaced by setDNSCacheMaxTTL/setDNSCacheMinTTL. ```bash void setDNSCacheExpiryTime( Unsigned Integer value ) ``` ### setDNSCacheExpiryTimeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now deprecated and is replaced by setDNSCacheMaxTTL/setDNSCacheMinTTL. This is a location specific function, any action will operate on the specified location. ```bash void setDNSCacheExpiryTimeByLocation( String location Unsigned Integer value ) ``` ### setDNSCacheMaxTTL( value ) throws InvalidInput, DeploymentError Set the maximum time entries are stored in the DNS cache for, in seconds. ```bash void setDNSCacheMaxTTL( Unsigned Integer value ) ``` ### setDNSCacheMaxTTLByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum time entries are stored in the DNS cache for, in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setDNSCacheMaxTTLByLocation( String location Unsigned Integer value ) ``` ### setDNSCacheMinTTL( value ) throws InvalidInput, DeploymentError Set the minimum time entries are stored in the DNS cache for, in seconds. ```bash void setDNSCacheMinTTL( Unsigned Integer value ) ``` ### setDNSCacheMinTTLByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the minimum time entries are stored in the DNS cache for, in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setDNSCacheMinTTLByLocation( String location Unsigned Integer value ) ``` ### setDNSCacheNegativeExpiryTime( value ) throws InvalidInput, DeploymentError Set the time failed lookups are stored in the DNS cache for, in seconds. ```bash void setDNSCacheNegativeExpiryTime( Unsigned Integer value ) ``` ### setDNSCacheNegativeExpiryTimeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the time failed lookups are stored in the DNS cache for, in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setDNSCacheNegativeExpiryTimeByLocation( String location Unsigned Integer value ) ``` ### setDNSCacheSize( value ) throws InvalidInput, DeploymentError Set the maximum number of entries in the DNS cache. ```bash void setDNSCacheSize( Unsigned Integer value ) ``` ### setDNSCacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of entries in the DNS cache. This is a location specific function, any action will operate on the specified location. ```bash void setDNSCacheSizeByLocation( String location Unsigned Integer value ) ``` ### setDNSTimeout( value ) throws InvalidInput, DeploymentError Set the timeout for receiving a response from a DNS Server, in seconds. ```bash void setDNSTimeout( Unsigned Integer value ) ``` ### setDNSTimeoutByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the timeout for receiving a response from a DNS Server, in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setDNSTimeoutByLocation( String location Unsigned Integer value ) ``` ### setDataPlaneAccelerationCores( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setDataPlaneAccelerationCores( GlobalSettings.DataPlaneAccelerationCores value ) ``` ### setDataPlaneAccelerationCoresByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setDataPlaneAccelerationCoresByLocation( String location GlobalSettings.DataPlaneAccelerationCores value ) ``` ### setDataPlaneAccelerationMode( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setDataPlaneAccelerationMode( Boolean value ) ``` ### setDataPlaneAccelerationModeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setDataPlaneAccelerationModeByLocation( String location Boolean value ) ``` ### setDataPlaneAccelerationTCPDelayAck( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setDataPlaneAccelerationTCPDelayAck( Unsigned Integer value ) ``` ### setDataPlaneAccelerationTCPDelayAckByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setDataPlaneAccelerationTCPDelayAckByLocation( String location Unsigned Integer value ) ``` ### setDataPlaneAccelerationTCPWinScale( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setDataPlaneAccelerationTCPWinScale( Unsigned Integer value ) ``` ### setDataPlaneAccelerationTCPWinScaleByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setDataPlaneAccelerationTCPWinScaleByLocation( String location Unsigned Integer value ) ``` ### setDeadTime( value ) throws InvalidInput, DeploymentError This method is now obsolete and is replaced by Pool.setNodeFailTime. ```bash void setDeadTime( Unsigned Integer value ) ``` ### setEC2AccessKeyID( value ) throws InvalidInput, DeploymentError Set DEPRECATED: Unused key. Assign an IAM Role to the EC2 instance to interact with AWS APIs. ```bash void setEC2AccessKeyID( String value ) ``` ### setEC2AccessKeyIDByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set DEPRECATED: Unused key. Assign an IAM Role to the EC2 instance to interact with AWS APIs. This is a location specific function, any action will operate on the specified location. ```bash void setEC2AccessKeyIDByLocation( String location String value ) ``` ### setEC2AwstoolTimeout( value ) throws InvalidInput, DeploymentError Set the timeout for awstool requests to the AWS Query Server ```bash void setEC2AwstoolTimeout( Unsigned Integer value ) ``` ### setEC2AwstoolTimeoutByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the timeout for awstool requests to the AWS Query Server This is a location specific function, any action will operate on the specified location. ```bash void setEC2AwstoolTimeoutByLocation( String location Unsigned Integer value ) ``` ### setEC2Endpoint( value ) throws InvalidInput, DeploymentError Set URL for the Amazon EC2 AWS endpoint. ```bash void setEC2Endpoint( String value ) ``` ### setEC2EndpointByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set URL for the Amazon EC2 AWS endpoint. This is a location specific function, any action will operate on the specified location. ```bash void setEC2EndpointByLocation( String location String value ) ``` ### setEC2MetadataServer( value ) throws InvalidInput, DeploymentError Set URL for the EC2 metadata server. ```bash void setEC2MetadataServer( String value ) ``` ### setEC2MetadataServerByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set URL for the EC2 metadata server. This is a location specific function, any action will operate on the specified location. ```bash void setEC2MetadataServerByLocation( String location String value ) ``` ### setEC2SecretAccessKey( value ) throws InvalidInput, DeploymentError Set DEPRECATED: Unused key. Assign an IAM Role to the EC2 instance to interact with AWS APIs. ```bash void setEC2SecretAccessKey( String value ) ``` ### setEC2SecretAccessKeyByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set DEPRECATED: Unused key. Assign an IAM Role to the EC2 instance to interact with AWS APIs. This is a location specific function, any action will operate on the specified location. ```bash void setEC2SecretAccessKeyByLocation( String location String value ) ``` ### setEC2VerifyEndpointCert( value ) throws InvalidInput, DeploymentError Set Whether to verify Amazon EC2 endpoint's certificate using CAs present in SSL Certificate Authorities Catalog. ```bash void setEC2VerifyEndpointCert( Boolean value ) ``` ### setEC2VerifyEndpointCertByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set Whether to verify Amazon EC2 endpoint's certificate using CAs present in SSL Certificate Authorities Catalog. This is a location specific function, any action will operate on the specified location. ```bash void setEC2VerifyEndpointCertByLocation( String location Boolean value ) ``` ### setErrorLevel( value ) throws InvalidInput, DeploymentError This method is now deprecated. ```bash void setErrorLevel( GlobalSettings.ErrorLevel value ) ``` ### setErrorLevelByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now deprecated. This is a location specific function, any action will operate on the specified location. ```bash void setErrorLevelByLocation( String location GlobalSettings.ErrorLevel value ) ``` ### setErrorLogFile( value ) throws InvalidInput, DeploymentError Set the filename that errors are logged to. ```bash void setErrorLogFile( String value ) ``` ### setErrorLogFileByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the filename that errors are logged to. This is a location specific function, any action will operate on the specified location. ```bash void setErrorLogFileByLocation( String location String value ) ``` ### setFTPDataBindLow( value ) throws InvalidInput, DeploymentError Set whether your traffic manager should permit use of FTP data connection source ports lower than 1024. If 'No' your traffic manager can completely drop root privileges, if 'Yes' some or all privileges may be retained in order to bind to low ports. ```bash void setFTPDataBindLow( Boolean value ) ``` ### setFTPDataBindLowByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether your traffic manager should permit use of FTP data connection source ports lower than 1024. If 'No' your traffic manager can completely drop root privileges, if 'Yes' some or all privileges may be retained in order to bind to low ports. This is a location specific function, any action will operate on the specified location. ```bash void setFTPDataBindLowByLocation( String location Boolean value ) ``` ### setFipsEnabled( value ) throws InvalidInput, DeploymentError, InvalidOperation Set whether FIPS Mode is enabled. ```bash void setFipsEnabled( Boolean value ) ``` ### setFlipperArpCount( value ) throws InvalidInput, DeploymentError Set the number of ARP packets each traffic manager sends when an IP address is raised. ```bash void setFlipperArpCount( Unsigned Integer value ) ``` ### setFlipperArpCountByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of ARP packets each traffic manager sends when an IP address is raised. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperArpCountByLocation( String location Unsigned Integer value ) ``` ### setFlipperAutofailback( value ) throws InvalidInput, DeploymentError Set whether Traffic IPs should automatically failback to recovered machines. ```bash void setFlipperAutofailback( Boolean value ) ``` ### setFlipperAutofailbackByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether Traffic IPs should automatically failback to recovered machines. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperAutofailbackByLocation( String location Boolean value ) ``` ### setFlipperAutofailbackDelay( value ) throws InvalidInput, DeploymentError Set the delay of automatic failback after a previous failover event. ```bash void setFlipperAutofailbackDelay( Unsigned Integer value ) ``` ### setFlipperAutofailbackDelayByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the delay of automatic failback after a previous failover event. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperAutofailbackDelayByLocation( String location Unsigned Integer value ) ``` ### setFlipperChildTimeout( value ) throws InvalidInput, DeploymentError Set how long (in seconds) the traffic manager should wait for status updates from any of the traffic manager's child processes before assuming one of them is no longer servicing traffic. ```bash void setFlipperChildTimeout( Unsigned Integer value ) ``` ### setFlipperChildTimeoutByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set how long (in seconds) the traffic manager should wait for status updates from any of the traffic manager's child processes before assuming one of them is no longer servicing traffic. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperChildTimeoutByLocation( String location Unsigned Integer value ) ``` ### setFlipperFrontendCheckAddresses( values ) throws InvalidInput, DeploymentError Set the IP addresses that should be used to check front-end connectivity. ```bash void setFlipperFrontendCheckAddresses( String[] values ) ``` ### setFlipperFrontendCheckAddressesByLocation( location, values ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the IP addresses that should be used to check front-end connectivity. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperFrontendCheckAddressesByLocation( String location String[] values ) ``` ### setFlipperHeartbeatMethod( value ) throws InvalidInput, DeploymentError Set the method used to exchange cluster heartbeat messages. ```bash void setFlipperHeartbeatMethod( GlobalSettings.FlipperHeartbeatMethod value ) ``` ### setFlipperHeartbeatMethodByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the method used to exchange cluster heartbeat messages. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperHeartbeatMethodByLocation( String location GlobalSettings.FlipperHeartbeatMethod value ) ``` ### setFlipperIGMPInterval( value ) throws InvalidInput, DeploymentError Set the interval between two unsolicited periodic IGMP Membership Report messages for Multi-Hosted Traffic IP Groups. ```bash void setFlipperIGMPInterval( Unsigned Integer value ) ``` ### setFlipperIGMPIntervalByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the interval between two unsolicited periodic IGMP Membership Report messages for Multi-Hosted Traffic IP Groups. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperIGMPIntervalByLocation( String location Unsigned Integer value ) ``` ### setFlipperL4AccelChildTimeout( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setFlipperL4AccelChildTimeout( Unsigned Integer value ) ``` ### setFlipperL4AccelChildTimeoutByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setFlipperL4AccelChildTimeoutByLocation( String location Unsigned Integer value ) ``` ### setFlipperL4AccelSyncPort( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setFlipperL4AccelSyncPort( Unsigned Integer value ) ``` ### setFlipperL4AccelSyncPortByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setFlipperL4AccelSyncPortByLocation( String location Unsigned Integer value ) ``` ### setFlipperMonitorInterval( value ) throws InvalidInput, DeploymentError Set how frequently (in milliseconds) each traffic manager checks and announces its connectivity. ```bash void setFlipperMonitorInterval( Unsigned Integer value ) ``` ### setFlipperMonitorIntervalByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set how frequently (in milliseconds) each traffic manager checks and announces its connectivity. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperMonitorIntervalByLocation( String location Unsigned Integer value ) ``` ### setFlipperMonitorTimeout( value ) throws InvalidInput, DeploymentError Set how long (in seconds) each traffic manager waits for a response from its connectivity tests or from other traffic managers before registering a failure. ```bash void setFlipperMonitorTimeout( Unsigned Integer value ) ``` ### setFlipperMonitorTimeoutByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set how long (in seconds) each traffic manager waits for a response from its connectivity tests or from other traffic managers before registering a failure. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperMonitorTimeoutByLocation( String location Unsigned Integer value ) ``` ### setFlipperMulticastAddress( value ) throws InvalidInput, DeploymentError Set the multicast address and port used to announce connectivity (e.g. 239.100.1.1:9090). ```bash void setFlipperMulticastAddress( String value ) ``` ### setFlipperMulticastAddressByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the multicast address and port used to announce connectivity (e.g. 239.100.1.1:9090). This is a location specific function, any action will operate on the specified location. ```bash void setFlipperMulticastAddressByLocation( String location String value ) ``` ### setFlipperUnicastPort( value ) throws InvalidInput, DeploymentError Set the unicast UDP port used to announce connectivity (e.g. 9090) ```bash void setFlipperUnicastPort( Unsigned Integer value ) ``` ### setFlipperUnicastPortByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the unicast UDP port used to announce connectivity (e.g. 9090) This is a location specific function, any action will operate on the specified location. ```bash void setFlipperUnicastPortByLocation( String location Unsigned Integer value ) ``` ### setFlipperUseBindip( value ) throws InvalidInput, DeploymentError Set whether the heartbeat messages used for fault tolerance are only sent over the management network. ```bash void setFlipperUseBindip( Boolean value ) ``` ### setFlipperUseBindipByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the heartbeat messages used for fault tolerance are only sent over the management network. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperUseBindipByLocation( String location Boolean value ) ``` ### setFlipperVerbose( value ) throws InvalidInput, DeploymentError Set whether the traffic manager should logs all the connectivity tests. ```bash void setFlipperVerbose( Boolean value ) ``` ### setFlipperVerboseByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the traffic manager should logs all the connectivity tests. This is a location specific function, any action will operate on the specified location. ```bash void setFlipperVerboseByLocation( String location Boolean value ) ``` ### setGLBLoadChangeLimit( value ) throws InvalidInput, DeploymentError Set the maximum change per second to load. ```bash void setGLBLoadChangeLimit( Unsigned Integer value ) ``` ### setGLBLoadChangeLimitByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum change per second to load. This is a location specific function, any action will operate on the specified location. ```bash void setGLBLoadChangeLimitByLocation( String location Unsigned Integer value ) ``` ### setGLBVerbose( value ) throws InvalidInput, DeploymentError Set whether GSLB should log all DNS queries ```bash void setGLBVerbose( Boolean value ) ``` ### setGLBVerboseByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether GSLB should log all DNS queries This is a location specific function, any action will operate on the specified location. ```bash void setGLBVerboseByLocation( String location Boolean value ) ``` ### setHistoricalTrafficDays( value ) throws InvalidInput, DeploymentError Set the length of time historical traffic information is kept for, in days (0=keep indefinitely). ```bash void setHistoricalTrafficDays( Unsigned Integer value ) ``` ### setHistoricalTrafficDaysByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the length of time historical traffic information is kept for, in days (0=keep indefinitely). This is a location specific function, any action will operate on the specified location. ```bash void setHistoricalTrafficDaysByLocation( String location Unsigned Integer value ) ``` ### setIPSessionCacheExpiry( value ) throws InvalidInput, DeploymentError Set IP session cache expiry time in seconds. ```bash void setIPSessionCacheExpiry( Unsigned Integer value ) ``` ### setIPSessionCacheExpiryByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set IP session cache expiry time in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setIPSessionCacheExpiryByLocation( String location Unsigned Integer value ) ``` ### setIPSessionCacheSize( value ) throws InvalidInput, DeploymentError Set the maximum number of entries in the IP session cache. ```bash void setIPSessionCacheSize( Unsigned Integer value ) ``` ### setIPSessionCacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of entries in the IP session cache. This is a location specific function, any action will operate on the specified location. ```bash void setIPSessionCacheSizeByLocation( String location Unsigned Integer value ) ``` ### setIdleConnectionTimeout( value ) throws InvalidInput, DeploymentError Set how long unused HTTP keepalive connections should be kept before being discarded, in seconds. ```bash void setIdleConnectionTimeout( Unsigned Integer value ) ``` ### setIdleConnectionTimeoutByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set how long unused HTTP keepalive connections should be kept before being discarded, in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setIdleConnectionTimeoutByLocation( String location Unsigned Integer value ) ``` ### setJ2EESessionCacheExpiry( value ) throws InvalidInput, DeploymentError Set J2EE session cache expiry time in seconds. ```bash void setJ2EESessionCacheExpiry( Unsigned Integer value ) ``` ### setJ2EESessionCacheExpiryByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set J2EE session cache expiry time in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setJ2EESessionCacheExpiryByLocation( String location Unsigned Integer value ) ``` ### setJ2EESessionCacheSize( value ) throws InvalidInput, DeploymentError Set the maximum number of entries in the J2EE session cache. ```bash void setJ2EESessionCacheSize( Unsigned Integer value ) ``` ### setJ2EESessionCacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of entries in the J2EE session cache. This is a location specific function, any action will operate on the specified location. ```bash void setJ2EESessionCacheSizeByLocation( String location Unsigned Integer value ) ``` ### setJavaClasspath( value ) throws InvalidInput, DeploymentError Set extra Java CLASSPATH settings required for servlets. ```bash void setJavaClasspath( String value ) ``` ### setJavaClasspathByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set extra Java CLASSPATH settings required for servlets. This is a location specific function, any action will operate on the specified location. ```bash void setJavaClasspathByLocation( String location String value ) ``` ### setJavaCommand( value ) throws InvalidInput, DeploymentError Set the command (and arguments) used to start Java. ```bash void setJavaCommand( String value ) ``` ### setJavaCommandByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the command (and arguments) used to start Java. This is a location specific function, any action will operate on the specified location. ```bash void setJavaCommandByLocation( String location String value ) ``` ### setJavaEnabled( value ) throws InvalidInput, DeploymentError Set whether to enable Java support. ```bash void setJavaEnabled( Boolean value ) ``` ### setJavaEnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether to enable Java support. This is a location specific function, any action will operate on the specified location. ```bash void setJavaEnabledByLocation( String location Boolean value ) ``` ### setJavaLib( value ) throws InvalidInput, DeploymentError Set the location of the java library directory ```bash void setJavaLib( String value ) ``` ### setJavaLibByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the location of the java library directory This is a location specific function, any action will operate on the specified location. ```bash void setJavaLibByLocation( String location String value ) ``` ### setJavaMaxConns( value ) throws InvalidInput, DeploymentError Set the maximum number of Java threads ```bash void setJavaMaxConns( Unsigned Integer value ) ``` ### setJavaMaxConnsByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of Java threads This is a location specific function, any action will operate on the specified location. ```bash void setJavaMaxConnsByLocation( String location Unsigned Integer value ) ``` ### setJavaSessionAge( value ) throws InvalidInput, DeploymentError Set the default maximum age of Java session persistence ```bash void setJavaSessionAge( Unsigned Integer value ) ``` ### setJavaSessionAgeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the default maximum age of Java session persistence This is a location specific function, any action will operate on the specified location. ```bash void setJavaSessionAgeByLocation( String location Unsigned Integer value ) ``` ### setKerberosVerbose( value ) throws InvalidInput, DeploymentError Set whether the traffic manager should log all Kerberos activity. ```bash void setKerberosVerbose( Boolean value ) ``` ### setKerberosVerboseByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the traffic manager should log all Kerberos activity. This is a location specific function, any action will operate on the specified location. ```bash void setKerberosVerboseByLocation( String location Boolean value ) ``` ### setL4AccelMaxConcurrentConnections( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setL4AccelMaxConcurrentConnections( Unsigned Integer value ) ``` ### setL4AccelMaxConcurrentConnectionsByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setL4AccelMaxConcurrentConnectionsByLocation( String location Unsigned Integer value ) ``` ### setLicenseServers( values ) throws InvalidInput, DeploymentError Set A list of license servers for FLA licensing. ```bash void setLicenseServers( String[] values ) ``` ### setLicenseServersByLocation( location, values ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set A list of license servers for FLA licensing. This is a location specific function, any action will operate on the specified location. ```bash void setLicenseServersByLocation( String location String[] values ) ``` ### setListenQueueSize( value ) throws InvalidInput, DeploymentError Set the size of the listen queue for managing incoming connections. ```bash void setListenQueueSize( Unsigned Integer value ) ``` ### setListenQueueSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the size of the listen queue for managing incoming connections. This is a location specific function, any action will operate on the specified location. ```bash void setListenQueueSizeByLocation( String location Unsigned Integer value ) ``` ### setLogExportAuthHTTP( value ) throws InvalidInput, DeploymentError Set the HTTP authentication method to use when exporting log entries. ```bash void setLogExportAuthHTTP( GlobalSettings.LogExportAuthHTTP value ) ``` ### setLogExportAuthHTTPByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the HTTP authentication method to use when exporting log entries. This is a location specific function, any action will operate on the specified location. ```bash void setLogExportAuthHTTPByLocation( String location GlobalSettings.LogExportAuthHTTP value ) ``` ### setLogExportAuthHecToken( value ) throws InvalidInput, DeploymentError Set the HTTP Event Collector token to use for HTTP authentication with a Splunk server. ```bash void setLogExportAuthHecToken( String value ) ``` ### setLogExportAuthHecTokenByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the HTTP Event Collector token to use for HTTP authentication with a Splunk server. This is a location specific function, any action will operate on the specified location. ```bash void setLogExportAuthHecTokenByLocation( String location String value ) ``` ### setLogExportAuthPassword( value ) throws InvalidInput, DeploymentError Set the password to use for HTTP basic authentication. ```bash void setLogExportAuthPassword( String value ) ``` ### setLogExportAuthPasswordByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the password to use for HTTP basic authentication. This is a location specific function, any action will operate on the specified location. ```bash void setLogExportAuthPasswordByLocation( String location String value ) ``` ### setLogExportAuthUsername( value ) throws InvalidInput, DeploymentError Set the username to use for HTTP basic authentication. ```bash void setLogExportAuthUsername( String value ) ``` ### setLogExportAuthUsernameByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the username to use for HTTP basic authentication. This is a location specific function, any action will operate on the specified location. ```bash void setLogExportAuthUsernameByLocation( String location String value ) ``` ### setLogExportEnabled( value ) throws InvalidInput, DeploymentError Set whether to monitor log files and export entries to the configured endpoint. ```bash void setLogExportEnabled( Boolean value ) ``` ### setLogExportEnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether to monitor log files and export entries to the configured endpoint. This is a location specific function, any action will operate on the specified location. ```bash void setLogExportEnabledByLocation( String location Boolean value ) ``` ### setLogExportEndpoint( value ) throws InvalidInput, DeploymentError Set the URL to which log entries should be sent. ```bash void setLogExportEndpoint( String value ) ``` ### setLogExportEndpointByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the URL to which log entries should be sent. This is a location specific function, any action will operate on the specified location. ```bash void setLogExportEndpointByLocation( String location String value ) ``` ### setLogExportRequestTimeout( value ) throws InvalidInput, DeploymentError Set the number of seconds after which HTTP requests sent to the configured endpoint will be considered to have failed if no response is received. ```bash void setLogExportRequestTimeout( Unsigned Integer value ) ``` ### setLogExportRequestTimeoutByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of seconds after which HTTP requests sent to the configured endpoint will be considered to have failed if no response is received. This is a location specific function, any action will operate on the specified location. ```bash void setLogExportRequestTimeoutByLocation( String location Unsigned Integer value ) ``` ### setLogExportTLSVerify( value ) throws InvalidInput, DeploymentError Set whether the server certificate should be verified when connecting to the endpoint. If enabled, server certificates that do not match the server name, are self-signed, have expired, have been revoked, or that are signed by an unknown CA will be rejected. ```bash void setLogExportTLSVerify( Boolean value ) ``` ### setLogExportTLSVerifyByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the server certificate should be verified when connecting to the endpoint. If enabled, server certificates that do not match the server name, are self-signed, have expired, have been revoked, or that are signed by an unknown CA will be rejected. This is a location specific function, any action will operate on the specified location. ```bash void setLogExportTLSVerifyByLocation( String location Boolean value ) ``` ### setLogFlushFlushTime( value ) throws InvalidInput, DeploymentError Set the length of time to wait before flushing the request log files for each virtual server, in seconds. ```bash void setLogFlushFlushTime( Unsigned Integer value ) ``` ### setLogFlushFlushTimeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the length of time to wait before flushing the request log files for each virtual server, in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setLogFlushFlushTimeByLocation( String location Unsigned Integer value ) ``` ### setLogInterval( value ) throws InvalidInput, DeploymentError Set the length of time between log messages for log intensive features e.g. SLM, in seconds. ```bash void setLogInterval( Unsigned Integer value ) ``` ### setLogIntervalByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the length of time between log messages for log intensive features e.g. SLM, in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setLogIntervalByLocation( String location Unsigned Integer value ) ``` ### setLogRate( value ) throws InvalidInput, DeploymentError Set is the maximum number of connection errors logged per second. ```bash void setLogRate( Unsigned Integer value ) ``` ### setLogRateByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set is the maximum number of connection errors logged per second. This is a location specific function, any action will operate on the specified location. ```bash void setLogRateByLocation( String location Unsigned Integer value ) ``` ### setLogReopenTime( value ) throws InvalidInput, DeploymentError Set the length of time to wait before re-opening request log files, to handle log file rotation, in seconds. ```bash void setLogReopenTime( Unsigned Integer value ) ``` ### setLogReopenTimeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the length of time to wait before re-opening request log files, to handle log file rotation, in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setLogReopenTimeByLocation( String location Unsigned Integer value ) ``` ### setLoginBanner( value ) throws InvalidInput, DeploymentError Set the banner text to be shown on the Admin Server login page and before logging in to appliance SSH servers. ```bash void setLoginBanner( String value ) ``` ### setLoginDelay( value ) throws InvalidInput, DeploymentError Set the number of seconds before another login attempt can be made after a failed attempt. ```bash void setLoginDelay( Unsigned Integer value ) ``` ### setMaxAccepting( value ) throws InvalidInput, DeploymentError Set how many traffic manager child processes accept new connections. ```bash void setMaxAccepting( Unsigned Integer value ) ``` ### setMaxAcceptingByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set how many traffic manager child processes accept new connections. This is a location specific function, any action will operate on the specified location. ```bash void setMaxAcceptingByLocation( String location Unsigned Integer value ) ``` ### setMaxGlobalTCPBufferSize( value ) throws InvalidInput, DeploymentError Set the maximum amount of memory allowed to be used by the vTM to buffer network data in user space for all TCP connections. ```bash void setMaxGlobalTCPBufferSize( String value ) ``` ### setMaxGlobalTCPBufferSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum amount of memory allowed to be used by the vTM to buffer network data in user space for all TCP connections. This is a location specific function, any action will operate on the specified location. ```bash void setMaxGlobalTCPBufferSizeByLocation( String location String value ) ``` ### setMaxIdleConnections( value ) throws InvalidInput, DeploymentError Set the maximum number of unused HTTP keepalive connections to all nodes that should maintained for re-use. ```bash void setMaxIdleConnections( Unsigned Integer value ) ``` ### setMaxIdleConnectionsByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of unused HTTP keepalive connections to all nodes that should maintained for re-use. This is a location specific function, any action will operate on the specified location. ```bash void setMaxIdleConnectionsByLocation( String location Unsigned Integer value ) ``` ### setMaxKeepalives( value ) throws InvalidInput, DeploymentError setMaxKeepalives is deprecated, please use setMaxIdleConnections instead. ```bash void setMaxKeepalives( Unsigned Integer value ) ``` ### setMaxKeepalivesByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist setMaxKeepalives is deprecated, please use setMaxIdleConnections instead. This is a location specific function, any action will operate on the specified location. ```bash void setMaxKeepalivesByLocation( String location Unsigned Integer value ) ``` ### setMaxLoginAttempts( value ) throws InvalidInput, DeploymentError Set the number of sequential failed login attempts that will cause a user account to be suspended. Setting this to 0 disables this feature. ```bash void setMaxLoginAttempts( Unsigned Integer value ) ``` ### setMaxLoginExternal( value ) throws InvalidInput, DeploymentError Set whether or not usernames blocked due to the max\_login\_attempts limit should also be blocked from authentication against external services (such as LDAP and RADIUS). ```bash void setMaxLoginExternal( Boolean value ) ``` ### setMaxLoginSuspensionTime( value ) throws InvalidInput, DeploymentError Set number of minutes to suspend users who have exceeded the max\_login\_attempts limit. ```bash void setMaxLoginSuspensionTime( Unsigned Integer value ) ``` ### setMaxRetries( value ) throws InvalidInput, DeploymentError This method is now obsolete and is replaced by Pool.setNodeConnectionAttempts. ```bash void setMaxRetries( Unsigned Integer value ) ``` ### setMaximumFDCount( value ) throws InvalidInput, DeploymentError Set the maximum number of file descriptors that your traffic manager will allocate ```bash void setMaximumFDCount( Unsigned Integer value ) ``` ### setMaximumFDCountByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of file descriptors that your traffic manager will allocate This is a location specific function, any action will operate on the specified location. ```bash void setMaximumFDCountByLocation( String location Unsigned Integer value ) ``` ### setMinAlphaChars( value ) throws InvalidInput, DeploymentError Set the minimum number of alphabetic characters in a password. ```bash void setMinAlphaChars( Unsigned Integer value ) ``` ### setMinNumericChars( value ) throws InvalidInput, DeploymentError Set the minimum number of numeric characters in a password. ```bash void setMinNumericChars( Unsigned Integer value ) ``` ### setMinPasswordLength( value ) throws InvalidInput, DeploymentError Set the minimum number of characters a password must contain. ```bash void setMinPasswordLength( Unsigned Integer value ) ``` ### setMinSpecialChars( value ) throws InvalidInput, DeploymentError Set the minimum number of special characters in a password. ```bash void setMinSpecialChars( Unsigned Integer value ) ``` ### setMinUppercaseChars( value ) throws InvalidInput, DeploymentError Set the minimum number of uppercase characters in a password. ```bash void setMinUppercaseChars( Unsigned Integer value ) ``` ### setMonitorNumNodes( value ) throws InvalidInput, DeploymentError Set the maximum number of nodes, pools and locations that can be monitored. ```bash void setMonitorNumNodes( Unsigned Integer value ) ``` ### setMonitorNumNodesByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of nodes, pools and locations that can be monitored. This is a location specific function, any action will operate on the specified location. ```bash void setMonitorNumNodesByLocation( String location Unsigned Integer value ) ``` ### setMultipleAccept( value ) throws InvalidInput, DeploymentError Set whether your traffic manager should try and read multiple new connections each time a new client connects. ```bash void setMultipleAccept( Boolean value ) ``` ### setMultipleAcceptByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether your traffic manager should try and read multiple new connections each time a new client connects. This is a location specific function, any action will operate on the specified location. ```bash void setMultipleAcceptByLocation( String location Boolean value ) ``` ### setNodeConnectionAttempts( value ) throws InvalidInput, DeploymentError This method is now obsolete and is replaced by Pool.setNodeConnectionAttempts. ```bash void setNodeConnectionAttempts( Unsigned Integer value ) ``` ### setNodeFailTime( value ) throws InvalidInput, DeploymentError This method is now obsolete and is replaced by Pool.setNodeFailTime. ```bash void setNodeFailTime( Unsigned Integer value ) ``` ### setOCSPCacheSize( value ) throws InvalidInput, DeploymentError Set the maximum number of cached client certificate OCSP results stored. This cache is used to speed up OCSP checks against client certificates by caching results. ```bash void setOCSPCacheSize( Unsigned Integer value ) ``` ### setOCSPCacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of cached client certificate OCSP results stored. This cache is used to speed up OCSP checks against client certificates by caching results. This is a location specific function, any action will operate on the specified location. ```bash void setOCSPCacheSizeByLocation( String location Unsigned Integer value ) ``` ### setOspfv2Area( value ) throws InvalidInput, DeploymentError Set the OSPF area in which the traffic manager will operate. ```bash void setOspfv2Area( String value ) ``` ### setOspfv2AreaByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the OSPF area in which the traffic manager will operate. This is a location specific function, any action will operate on the specified location. ```bash void setOspfv2AreaByLocation( String location String value ) ``` ### setOspfv2AreaType( value ) throws InvalidInput, DeploymentError Set the type of OSPF area ```bash void setOspfv2AreaType( GlobalSettings.Ospfv2AreaType value ) ``` ### setOspfv2AreaTypeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the type of OSPF area This is a location specific function, any action will operate on the specified location. ```bash void setOspfv2AreaTypeByLocation( String location GlobalSettings.Ospfv2AreaType value ) ``` ### setOspfv2AuthenticationKeyIdA( value ) throws InvalidInput, DeploymentError Set the OSPF key ID ```bash void setOspfv2AuthenticationKeyIdA( Unsigned Integer value ) ``` ### setOspfv2AuthenticationKeyIdAByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the OSPF key ID This is a location specific function, any action will operate on the specified location. ```bash void setOspfv2AuthenticationKeyIdAByLocation( String location Unsigned Integer value ) ``` ### setOspfv2AuthenticationKeyIdB( value ) throws InvalidInput, DeploymentError Set the OSPF key ID ```bash void setOspfv2AuthenticationKeyIdB( Unsigned Integer value ) ``` ### setOspfv2AuthenticationKeyIdBByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the OSPF key ID This is a location specific function, any action will operate on the specified location. ```bash void setOspfv2AuthenticationKeyIdBByLocation( String location Unsigned Integer value ) ``` ### setOspfv2AuthenticationSharedSecretA( value ) throws InvalidInput, DeploymentError Set the OSPF MD5 shared secret, set to "" to disable. ```bash void setOspfv2AuthenticationSharedSecretA( String value ) ``` ### setOspfv2AuthenticationSharedSecretAByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the OSPF MD5 shared secret, set to "" to disable. This is a location specific function, any action will operate on the specified location. ```bash void setOspfv2AuthenticationSharedSecretAByLocation( String location String value ) ``` ### setOspfv2AuthenticationSharedSecretB( value ) throws InvalidInput, DeploymentError Set the OSPF MD5 shared secret, set to "" to disable. ```bash void setOspfv2AuthenticationSharedSecretB( String value ) ``` ### setOspfv2AuthenticationSharedSecretBByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the OSPF MD5 shared secret, set to "" to disable. This is a location specific function, any action will operate on the specified location. ```bash void setOspfv2AuthenticationSharedSecretBByLocation( String location String value ) ``` ### setOspfv2DeadInterval( value ) throws InvalidInput, DeploymentError Set the number of seconds before declaring a silent router down. ```bash void setOspfv2DeadInterval( Unsigned Integer value ) ``` ### setOspfv2DeadIntervalByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of seconds before declaring a silent router down. This is a location specific function, any action will operate on the specified location. ```bash void setOspfv2DeadIntervalByLocation( String location Unsigned Integer value ) ``` ### setOspfv2Enabled( value ) throws InvalidInput, DeploymentError Set whether OSPF Route Health Injection is enabled ```bash void setOspfv2Enabled( Boolean value ) ``` ### setOspfv2EnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether OSPF Route Health Injection is enabled This is a location specific function, any action will operate on the specified location. ```bash void setOspfv2EnabledByLocation( String location Boolean value ) ``` ### setOspfv2HelloInterval( value ) throws InvalidInput, DeploymentError Set the interval at which OSPF "hello" packets are sent to the network. ```bash void setOspfv2HelloInterval( Unsigned Integer value ) ``` ### setOspfv2HelloIntervalByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the interval at which OSPF "hello" packets are sent to the network. This is a location specific function, any action will operate on the specified location. ```bash void setOspfv2HelloIntervalByLocation( String location Unsigned Integer value ) ``` ### setOspfv2RouterDeadInterval( value ) throws InvalidInput, DeploymentError This method is now deprecated and is replaced by setOspfv2DeadInterval. ```bash void setOspfv2RouterDeadInterval( Unsigned Integer value ) ``` ### setOspfv2RouterDeadIntervalByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now deprecated and is replaced by setOspfv2DeadInterval. This is a location specific function, any action will operate on the specified location. ```bash void setOspfv2RouterDeadIntervalByLocation( String location Unsigned Integer value ) ``` ### setPasswordChangesPerDay( value ) throws InvalidInput, DeploymentError Set the maximum number of times a password can be changed every 24 hours. ```bash void setPasswordChangesPerDay( Unsigned Integer value ) ``` ### setPasswordReuseAfter( value ) throws InvalidInput, DeploymentError Set the number of times a password must have been changed before it can be reused. ```bash void setPasswordReuseAfter( Unsigned Integer value ) ``` ### setPostLoginBanner( value ) throws InvalidInput, DeploymentError Set the banner text to be displayed on the appliance console after login. ```bash void setPostLoginBanner( String value ) ``` ### setProtectionConncountSize( value ) throws InvalidInput, DeploymentError Set the amount of shared memory reserved for an inter-process table of combined connection counts used by Service Protection classes (specified as an absolute size, eg 20MB). ```bash void setProtectionConncountSize( String value ) ``` ### setProtectionConncountSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the amount of shared memory reserved for an inter-process table of combined connection counts used by Service Protection classes (specified as an absolute size, eg 20MB). This is a location specific function, any action will operate on the specified location. ```bash void setProtectionConncountSizeByLocation( String location String value ) ``` ### setRESTAuthTimeout( value ) throws InvalidInput, DeploymentError Set REST authentication timeout. ```bash void setRESTAuthTimeout( Unsigned Integer value ) ``` ### setRESTEnabled( value ) throws InvalidInput, DeploymentError Set whether REST service is enabled. ```bash void setRESTEnabled( Boolean value ) ``` ### setRESTMaxHTTPHeaderLength( value ) throws InvalidInput, DeploymentError Set the maximum allowed length in bytes of a HTTP request's headers. ```bash void setRESTMaxHTTPHeaderLength( Unsigned Integer value ) ``` ### setRESTMaximumFDCount( value ) throws InvalidInput, DeploymentError Set the maximum number of file descriptors that the REST API will allocate. ```bash void setRESTMaximumFDCount( Unsigned Integer value ) ``` ### setRESTReplicateAbsoluteTime( value ) throws InvalidInput, DeploymentError Set Absolute time before configuration replication via REST. ```bash void setRESTReplicateAbsoluteTime( Unsigned Integer value ) ``` ### setRESTReplicateLullTime( value ) throws InvalidInput, DeploymentError Set Lull time for configuration replication via REST. ```bash void setRESTReplicateLullTime( Unsigned Integer value ) ``` ### setRESTReplicateTimeout( value ) throws InvalidInput, DeploymentError Set the configuration replication timeout via REST. ```bash void setRESTReplicateTimeout( Unsigned Integer value ) ``` ### setRateClassLimit( value ) throws InvalidInput, DeploymentError Set the maximum number of Rate classes allowed. ```bash void setRateClassLimit( Unsigned Integer value ) ``` ### setRateClassLimitByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of Rate classes allowed. This is a location specific function, any action will operate on the specified location. ```bash void setRateClassLimitByLocation( String location Unsigned Integer value ) ``` ### setRecentConns( value ) throws InvalidInput, DeploymentError Set the details of how many recently closed connections each traffic manager process should save for use with the Connections page. ```bash void setRecentConns( Unsigned Integer value ) ``` ### setRecentConnsByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the details of how many recently closed connections each traffic manager process should save for use with the Connections page. This is a location specific function, any action will operate on the specified location. ```bash void setRecentConnsByLocation( String location Unsigned Integer value ) ``` ### setRecentConnsRetainTime( value ) throws InvalidInput, DeploymentError Set for how long a snapshot should be retained on the Connections page. ```bash void setRecentConnsRetainTime( Unsigned Integer value ) ``` ### setRecentConnsRetainTimeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set for how long a snapshot should be retained on the Connections page. This is a location specific function, any action will operate on the specified location. ```bash void setRecentConnsRetainTimeByLocation( String location Unsigned Integer value ) ``` ### setRecentConnsSnapshotSize( value ) throws InvalidInput, DeploymentError Set the maximum number of connections each traffic manager process should show for a snapshot on the Connections page. ```bash void setRecentConnsSnapshotSize( Unsigned Integer value ) ``` ### setRecentConnsSnapshotSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of connections each traffic manager process should show for a snapshot on the Connections page. This is a location specific function, any action will operate on the specified location. ```bash void setRecentConnsSnapshotSizeByLocation( String location Unsigned Integer value ) ``` ### setSLMClassLimit( value ) throws InvalidInput, DeploymentError Set the maximum number of SLM classes allowed. ```bash void setSLMClassLimit( Unsigned Integer value ) ``` ### setSLMClassLimitByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of SLM classes allowed. This is a location specific function, any action will operate on the specified location. ```bash void setSLMClassLimitByLocation( String location Unsigned Integer value ) ``` ### setSNATIPLimit( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setSNATIPLimit( Unsigned Integer value ) ``` ### setSNATIPLimitByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setSNATIPLimitByLocation( String location Unsigned Integer value ) ``` ### setSNATIPLocalPortRangeHigh( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setSNATIPLocalPortRangeHigh( Unsigned Integer value ) ``` ### setSNATIPLocalPortRangeHighByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setSNATIPLocalPortRangeHighByLocation( String location Unsigned Integer value ) ``` ### setSNATSharedPoolSize( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setSNATSharedPoolSize( Unsigned Integer value ) ``` ### setSNATSharedPoolSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setSNATSharedPoolSizeByLocation( String location Unsigned Integer value ) ``` ### setSNMPUserCounters( value ) throws InvalidInput, DeploymentError Set the number of user defined SNMP counters (this single parameter dictates the numbers of both 32- and 64-bit user counters - there is always the same number of counters of each type). ```bash void setSNMPUserCounters( Unsigned Integer value ) ``` ### setSNMPUserCountersByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of user defined SNMP counters (this single parameter dictates the numbers of both 32- and 64-bit user counters - there is always the same number of counters of each type). This is a location specific function, any action will operate on the specified location. ```bash void setSNMPUserCountersByLocation( String location Unsigned Integer value ) ``` ### setSSL3AllowRehandshake( value ) throws InvalidInput, DeploymentError This methods is deprecated and is replaced by GlobalSettings.setSSLAllowRehandshake. ```bash void setSSL3AllowRehandshake( GlobalSettings.SSL3AllowRehandshake value ) ``` ### setSSL3AllowRehandshakeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This methods is deprecated and is replaced by GlobalSettings.setSSLAllowRehandshake. This is a location specific function, any action will operate on the specified location. ```bash void setSSL3AllowRehandshakeByLocation( String location GlobalSettings.SSL3AllowRehandshake value ) ``` ### setSSL3Ciphers( value ) throws InvalidInput, DeploymentError This method is deprecated and is replaced by GlobalSettings.setSSLCipherSuites. ```bash void setSSL3Ciphers( String value ) ``` ### setSSL3CiphersByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is deprecated and is replaced by GlobalSettings.setSSLCipherSuites. This is a location specific function, any action will operate on the specified location. ```bash void setSSL3CiphersByLocation( String location String value ) ``` ### setSSL3DiffieHellmanKeyLength( value ) throws InvalidInput, DeploymentError This methods is deprecated and is replaced by GlobalSettings.setSSLDiffieHellmanModulusSize. ```bash void setSSL3DiffieHellmanKeyLength( GlobalSettings.SSL3DiffieHellmanKeyLength value ) ``` ### setSSL3DiffieHellmanKeyLengthByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This methods is deprecated and is replaced by GlobalSettings.setSSLDiffieHellmanModulusSize. This is a location specific function, any action will operate on the specified location. ```bash void setSSL3DiffieHellmanKeyLengthByLocation( String location GlobalSettings.SSL3DiffieHellmanKeyLength value ) ``` ### setSSL3MinRehandshakeInterval( value ) throws InvalidInput, DeploymentError This methods is deprecated and is replaced by GlobalSettings.setSSLMinRehandshakeInterval. ```bash void setSSL3MinRehandshakeInterval( Unsigned Integer value ) ``` ### setSSLAllowRehandshake( value ) throws InvalidInput, DeploymentError Set whether SSL/TLS re-handshakes are supported. ```bash void setSSLAllowRehandshake( GlobalSettings.SSLAllowRehandshake value ) ``` ### setSSLAllowRehandshakeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether SSL/TLS re-handshakes are supported. This is a location specific function, any action will operate on the specified location. ```bash void setSSLAllowRehandshakeByLocation( String location GlobalSettings.SSLAllowRehandshake value ) ``` ### setSSLAzureClientID( value ) throws InvalidInput, DeploymentError Set the client identifier for the Azure Key Vault. ```bash void setSSLAzureClientID( String value ) ``` ### setSSLAzureClientIDByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the client identifier for the Azure Key Vault. This is a location specific function, any action will operate on the specified location. ```bash void setSSLAzureClientIDByLocation( String location String value ) ``` ### setSSLAzureClientSecret( value ) throws InvalidInput, DeploymentError Set the client secret for the Azure Key Vault. ```bash void setSSLAzureClientSecret( String value ) ``` ### setSSLAzureClientSecretByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the client secret for the Azure Key Vault. This is a location specific function, any action will operate on the specified location. ```bash void setSSLAzureClientSecretByLocation( String location String value ) ``` ### setSSLAzureVaultURL( value ) throws InvalidInput, DeploymentError Set the URL of the Azure Key Vault REST API. ```bash void setSSLAzureVaultURL( String value ) ``` ### setSSLAzureVaultURLByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the URL of the Azure Key Vault REST API. This is a location specific function, any action will operate on the specified location. ```bash void setSSLAzureVaultURLByLocation( String location String value ) ``` ### setSSLAzureVerifyRESTAPICert( value ) throws InvalidInput, DeploymentError Set whether the SSL certificate of the Azure Key Vault REST API will be verified using CAs present in the SSL Certificate Authorities Catalog. ```bash void setSSLAzureVerifyRESTAPICert( Boolean value ) ``` ### setSSLAzureVerifyRESTAPICertByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the SSL certificate of the Azure Key Vault REST API will be verified using CAs present in the SSL Certificate Authorities Catalog. This is a location specific function, any action will operate on the specified location. ```bash void setSSLAzureVerifyRESTAPICertByLocation( String location Boolean value ) ``` ### setSSLCRLMemSize( value ) throws InvalidInput, DeploymentError Set the size of the CRL shared memory. ```bash void setSSLCRLMemSize( String value ) ``` ### setSSLCRLMemSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the size of the CRL shared memory. This is a location specific function, any action will operate on the specified location. ```bash void setSSLCRLMemSizeByLocation( String location String value ) ``` ### setSSLCipherSuites( value ) throws InvalidInput, DeploymentError Set the SSL/TLS cipher suites preference list for SSL/TLS connections unless overridden by virtual server or pool settings ```bash void setSSLCipherSuites( String value ) ``` ### setSSLCipherSuitesByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the SSL/TLS cipher suites preference list for SSL/TLS connections unless overridden by virtual server or pool settings This is a location specific function, any action will operate on the specified location. ```bash void setSSLCipherSuitesByLocation( String location String value ) ``` ### setSSLClientCacheEnabled( value ) throws InvalidInput, DeploymentError Set whether the SSL client cache will be used, unless overridden by pool settings. ```bash void setSSLClientCacheEnabled( Boolean value ) ``` ### setSSLClientCacheEnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the SSL client cache will be used, unless overridden by pool settings. This is a location specific function, any action will operate on the specified location. ```bash void setSSLClientCacheEnabledByLocation( String location Boolean value ) ``` ### setSSLClientCacheExpiry( value ) throws InvalidInput, DeploymentError Set the length of time that SSL sessions are stored in the client cache (for SSL encryption), in seconds. ```bash void setSSLClientCacheExpiry( Unsigned Integer value ) ``` ### setSSLClientCacheExpiryByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the length of time that SSL sessions are stored in the client cache (for SSL encryption), in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setSSLClientCacheExpiryByLocation( String location Unsigned Integer value ) ``` ### setSSLClientCacheSize( value ) throws InvalidInput, DeploymentError Set the number of entries in the SSL encryption session cache. ```bash void setSSLClientCacheSize( Unsigned Integer value ) ``` ### setSSLClientCacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of entries in the SSL encryption session cache. This is a location specific function, any action will operate on the specified location. ```bash void setSSLClientCacheSizeByLocation( String location Unsigned Integer value ) ``` ### setSSLClientTicketsEnabled( value ) throws InvalidInput, DeploymentError Set whether session tickets may be requested and stored in the SSL client cache. ```bash void setSSLClientTicketsEnabled( Boolean value ) ``` ### setSSLClientTicketsEnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether session tickets may be requested and stored in the SSL client cache. This is a location specific function, any action will operate on the specified location. ```bash void setSSLClientTicketsEnabledByLocation( String location Boolean value ) ``` ### setSSLDFailureCount( value ) throws InvalidInput, DeploymentError setSSLDFailureCount is deprecated, please use setSSLHardwareFailureCount instead. ```bash void setSSLDFailureCount( Unsigned Integer value ) ``` ### setSSLDFailureCountByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist setSSLDFailureCount is deprecated, please use setSSLHardwareFailureCount instead. This is a location specific function, any action will operate on the specified location. ```bash void setSSLDFailureCountByLocation( String location Unsigned Integer value ) ``` ### setSSLDPKCS11Lib( value ) throws InvalidInput, DeploymentError setSSLDPKCS11Lib is deprecated, please use setSSLHardwarePKCS11Lib instead. ```bash void setSSLDPKCS11Lib( String value ) ``` ### setSSLDPKCS11LibByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist setSSLDPKCS11Lib is deprecated, please use setSSLHardwarePKCS11Lib instead. This is a location specific function, any action will operate on the specified location. ```bash void setSSLDPKCS11LibByLocation( String location String value ) ``` ### setSSLDPKCS11UserPIN( value ) throws InvalidInput, DeploymentError setSSLDPKCS11UserPIN is deprecated, please use setSSLHardwarePKCS11UserPIN instead. ```bash void setSSLDPKCS11UserPIN( String value ) ``` ### setSSLDPKCS11UserPINByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist setSSLDPKCS11UserPIN is deprecated, please use setSSLHardwarePKCS11UserPIN instead. This is a location specific function, any action will operate on the specified location. ```bash void setSSLDPKCS11UserPINByLocation( String location String value ) ``` ### setSSLDiffieHellmanModulusSize( value ) throws InvalidInput, DeploymentError Set the number of bits to use for the finite field Diffie-Hellman modulus ```bash void setSSLDiffieHellmanModulusSize( GlobalSettings.SSLDiffieHellmanModulusSize value ) ``` ### setSSLDiffieHellmanModulusSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of bits to use for the finite field Diffie-Hellman modulus This is a location specific function, any action will operate on the specified location. ```bash void setSSLDiffieHellmanModulusSizeByLocation( String location GlobalSettings.SSLDiffieHellmanModulusSize value ) ``` ### setSSLEllipticCurves( value ) throws InvalidInput, DeploymentError Set the elliptic curve preference list for SSL/TLS connections unless overridden by virtual server or pool settings ```bash void setSSLEllipticCurves( String value ) ``` ### setSSLEllipticCurvesByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the elliptic curve preference list for SSL/TLS connections unless overridden by virtual server or pool settings This is a location specific function, any action will operate on the specified location. ```bash void setSSLEllipticCurvesByLocation( String location String value ) ``` ### setSSLHardwareAccelerator( value ) throws InvalidInput, DeploymentError Set whether your traffic manager should always attempt to use SSL hardware. ```bash void setSSLHardwareAccelerator( Boolean value ) ``` ### setSSLHardwareAcceleratorByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether your traffic manager should always attempt to use SSL hardware. This is a location specific function, any action will operate on the specified location. ```bash void setSSLHardwareAcceleratorByLocation( String location Boolean value ) ``` ### setSSLHardwareFailureCount( value ) throws InvalidInput, DeploymentError Set the number of consecutive failures from the SSL hardware that will be tolerated before your traffic manager tries to log in again. ```bash void setSSLHardwareFailureCount( Unsigned Integer value ) ``` ### setSSLHardwareFailureCountByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of consecutive failures from the SSL hardware that will be tolerated before your traffic manager tries to log in again. This is a location specific function, any action will operate on the specified location. ```bash void setSSLHardwareFailureCountByLocation( String location Unsigned Integer value ) ``` ### setSSLHardwarePKCS11Lib( value ) throws InvalidInput, DeploymentError Set the location of the PKCS#11 library supplied by your hardware vendor. ```bash void setSSLHardwarePKCS11Lib( String value ) ``` ### setSSLHardwarePKCS11LibByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the location of the PKCS#11 library supplied by your hardware vendor. This is a location specific function, any action will operate on the specified location. ```bash void setSSLHardwarePKCS11LibByLocation( String location String value ) ``` ### setSSLHardwarePKCS11SlotLabel( value ) throws InvalidInput, DeploymentError Set the label of the SSL hardware slot to use. ```bash void setSSLHardwarePKCS11SlotLabel( String value ) ``` ### setSSLHardwarePKCS11SlotLabelByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the label of the SSL hardware slot to use. This is a location specific function, any action will operate on the specified location. ```bash void setSSLHardwarePKCS11SlotLabelByLocation( String location String value ) ``` ### setSSLHardwarePKCS11SlotType( value ) throws InvalidInput, DeploymentError Set the type of PKCS11 slot to use. Only used for PKCS11. ```bash void setSSLHardwarePKCS11SlotType( GlobalSettings.SSLHardwarePKCS11SlotType value ) ``` ### setSSLHardwarePKCS11SlotTypeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the type of PKCS11 slot to use. Only used for PKCS11. This is a location specific function, any action will operate on the specified location. ```bash void setSSLHardwarePKCS11SlotTypeByLocation( String location GlobalSettings.SSLHardwarePKCS11SlotType value ) ``` ### setSSLHardwarePKCS11UserPIN( value ) throws InvalidInput, DeploymentError Set the user PIN for the PKCS token (PKCS#11 devices only) ```bash void setSSLHardwarePKCS11UserPIN( String value ) ``` ### setSSLHardwarePKCS11UserPINByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the user PIN for the PKCS token (PKCS#11 devices only) This is a location specific function, any action will operate on the specified location. ```bash void setSSLHardwarePKCS11UserPINByLocation( String location String value ) ``` ### setSSLHardwareType( value ) throws InvalidInput, DeploymentError Set the device driver library name. ```bash void setSSLHardwareType( GlobalSettings.SSLHardwareType value ) ``` ### setSSLHardwareTypeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the device driver library name. This is a location specific function, any action will operate on the specified location. ```bash void setSSLHardwareTypeByLocation( String location GlobalSettings.SSLHardwareType value ) ``` ### setSSLHonorFallbackSCSV( value ) throws InvalidInput, DeploymentError Set whether ssl-decrypting Virtual Servers honor the Fallback SCSV ```bash void setSSLHonorFallbackSCSV( Boolean value ) ``` ### setSSLHonorFallbackSCSVByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether ssl-decrypting Virtual Servers honor the Fallback SCSV This is a location specific function, any action will operate on the specified location. ```bash void setSSLHonorFallbackSCSVByLocation( String location Boolean value ) ``` ### setSSLInsertExtraFragment( value ) throws InvalidInput, DeploymentError Set whether SSL3 and TLS1 use one byte fragments ```bash void setSSLInsertExtraFragment( Boolean value ) ``` ### setSSLInsertExtraFragmentByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether SSL3 and TLS1 use one byte fragments This is a location specific function, any action will operate on the specified location. ```bash void setSSLInsertExtraFragmentByLocation( String location Boolean value ) ``` ### setSSLLogKeys( value ) throws InvalidInput, DeploymentError Set Whether SSL key logging should be available. ```bash void setSSLLogKeys( Boolean value ) ``` ### setSSLLogKeysByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set Whether SSL key logging should be available. This is a location specific function, any action will operate on the specified location. ```bash void setSSLLogKeysByLocation( String location Boolean value ) ``` ### setSSLMaxHandshakeMessageSize( value ) throws InvalidInput, DeploymentError Set the maximum acceptable size (in bytes) a SSL handshake message is permitted to be. ```bash void setSSLMaxHandshakeMessageSize( Unsigned Integer value ) ``` ### setSSLMaxHandshakeMessageSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum acceptable size (in bytes) a SSL handshake message is permitted to be. This is a location specific function, any action will operate on the specified location. ```bash void setSSLMaxHandshakeMessageSizeByLocation( String location Unsigned Integer value ) ``` ### setSSLMiddleboxCompatibility( value ) throws InvalidInput, DeploymentError Set whether TLS 1.3 middlebox compatibility mode will be used, unless overridden by pool settings. ```bash void setSSLMiddleboxCompatibility( Boolean value ) ``` ### setSSLMiddleboxCompatibilityByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether TLS 1.3 middlebox compatibility mode will be used, unless overridden by pool settings. This is a location specific function, any action will operate on the specified location. ```bash void setSSLMiddleboxCompatibilityByLocation( String location Boolean value ) ``` ### setSSLMinRehandshakeInterval( value ) throws InvalidInput, DeploymentError Set the minimum time interval (in milliseconds) between handshakes on a single SSL3/TLS connection. ```bash void setSSLMinRehandshakeInterval( Unsigned Integer value ) ``` ### setSSLMinRehandshakeIntervalByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the minimum time interval (in milliseconds) between handshakes on a single SSL3/TLS connection. This is a location specific function, any action will operate on the specified location. ```bash void setSSLMinRehandshakeIntervalByLocation( String location Unsigned Integer value ) ``` ### setSSLOCSPStaplingDefaultRefreshInterval( value ) throws InvalidInput, DeploymentError Set how long to wait before refreshing requests on behalf of the store of certificate status responses used by OCSP stapling, if we don't have an up-to-date OCSP response. ```bash void setSSLOCSPStaplingDefaultRefreshInterval( Unsigned Integer value ) ``` ### setSSLOCSPStaplingDefaultRefreshIntervalByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set how long to wait before refreshing requests on behalf of the store of certificate status responses used by OCSP stapling, if we don't have an up-to-date OCSP response. This is a location specific function, any action will operate on the specified location. ```bash void setSSLOCSPStaplingDefaultRefreshIntervalByLocation( String location Unsigned Integer value ) ``` ### setSSLOCSPStaplingMaximumRefreshInterval( value ) throws InvalidInput, DeploymentError Set maximum number of seconds to wait before refreshing requests on behalf of the store of certificate status responses used by OCSP stapling. (0 means no maximum.) ```bash void setSSLOCSPStaplingMaximumRefreshInterval( Unsigned Integer value ) ``` ### setSSLOCSPStaplingMaximumRefreshIntervalByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set maximum number of seconds to wait before refreshing requests on behalf of the store of certificate status responses used by OCSP stapling. (0 means no maximum.) This is a location specific function, any action will operate on the specified location. ```bash void setSSLOCSPStaplingMaximumRefreshIntervalByLocation( String location Unsigned Integer value ) ``` ### setSSLOCSPStaplingMemSize( value ) throws InvalidInput, DeploymentError Set the size of the OCSP stapling response shared memory. ```bash void setSSLOCSPStaplingMemSize( String value ) ``` ### setSSLOCSPStaplingMemSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the size of the OCSP stapling response shared memory. This is a location specific function, any action will operate on the specified location. ```bash void setSSLOCSPStaplingMemSizeByLocation( String location String value ) ``` ### setSSLOCSPStaplingTimeTolerance( value ) throws InvalidInput, DeploymentError Set how many seconds to allow the current time to be outside the validity time of an OCSP response before considering it invalid. ```bash void setSSLOCSPStaplingTimeTolerance( Unsigned Integer value ) ``` ### setSSLOCSPStaplingTimeToleranceByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set how many seconds to allow the current time to be outside the validity time of an OCSP response before considering it invalid. This is a location specific function, any action will operate on the specified location. ```bash void setSSLOCSPStaplingTimeToleranceByLocation( String location Unsigned Integer value ) ``` ### setSSLOCSPStaplingVerifyResponse( value ) throws InvalidInput, DeploymentError Set whether to verify the OCSP response signature before caching a response for OCSP stapling. ```bash void setSSLOCSPStaplingVerifyResponse( Boolean value ) ``` ### setSSLOCSPStaplingVerifyResponseByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether to verify the OCSP response signature before caching a response for OCSP stapling. This is a location specific function, any action will operate on the specified location. ```bash void setSSLOCSPStaplingVerifyResponseByLocation( String location Boolean value ) ``` ### setSSLPreventTimingSideChannels( value ) throws InvalidInput, DeploymentError This method is now obsolete ```bash void setSSLPreventTimingSideChannels( Boolean value ) ``` ### setSSLPreventTimingSideChannelsByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete ```bash void setSSLPreventTimingSideChannelsByLocation( String location Boolean value ) ``` ### setSSLSessionCachePerVirtualserver( value ) throws InvalidInput, DeploymentError Set whether an SSL session created by a given virtual server can only be resumed by a connection to the same virtual server. ```bash void setSSLSessionCachePerVirtualserver( Boolean value ) ``` ### setSSLSessionCachePerVirtualserverByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether an SSL session created by a given virtual server can only be resumed by a connection to the same virtual server. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSessionCachePerVirtualserverByLocation( String location Boolean value ) ``` ### setSSLSessionCacheSize( value ) throws InvalidInput, DeploymentError Set the maximum number of entries in the SSL session cache. This is used to provide persistence based on SSL session IDs. ```bash void setSSLSessionCacheSize( Unsigned Integer value ) ``` ### setSSLSessionCacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of entries in the SSL session cache. This is used to provide persistence based on SSL session IDs. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSessionCacheSizeByLocation( String location Unsigned Integer value ) ``` ### setSSLSessionIDCacheEnabled( value ) throws InvalidInput, DeploymentError Set whether the SSL server session cache is enabled, unless overridden by virtual server settings. ```bash void setSSLSessionIDCacheEnabled( Boolean value ) ``` ### setSSLSessionIDCacheEnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the SSL server session cache is enabled, unless overridden by virtual server settings. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSessionIDCacheEnabledByLocation( String location Boolean value ) ``` ### setSSLSessionIDCacheExpiryTime( value ) throws InvalidInput, DeploymentError Set the length of time that SSL session IDs are stored, in seconds. ```bash void setSSLSessionIDCacheExpiryTime( Unsigned Integer value ) ``` ### setSSLSessionIDCacheExpiryTimeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the length of time that SSL session IDs are stored, in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSessionIDCacheExpiryTimeByLocation( String location Unsigned Integer value ) ``` ### setSSLSessionIDCacheSize( value ) throws InvalidInput, DeploymentError Set the number of entries in the SSL session ID cache. ```bash void setSSLSessionIDCacheSize( Unsigned Integer value ) ``` ### setSSLSessionIDCacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of entries in the SSL session ID cache. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSessionIDCacheSizeByLocation( String location Unsigned Integer value ) ``` ### setSSLSignatureAlgorithms( value ) throws InvalidInput, DeploymentError Set the SSL/TLS signature algorithms preference list for SSL/TLS connections unless overridden by virtual server or pool settings ```bash void setSSLSignatureAlgorithms( String value ) ``` ### setSSLSignatureAlgorithmsByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the SSL/TLS signature algorithms preference list for SSL/TLS connections unless overridden by virtual server or pool settings This is a location specific function, any action will operate on the specified location. ```bash void setSSLSignatureAlgorithmsByLocation( String location String value ) ``` ### setSSLSupportSSL2( value ) throws InvalidInput, DeploymentError This method is now deprecated. ```bash void setSSLSupportSSL2( Boolean value ) ``` ### setSSLSupportSSL2ByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now deprecated. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSupportSSL2ByLocation( String location Boolean value ) ``` ### setSSLSupportSSL3( value ) throws InvalidInput, DeploymentError Set whether SSLv3 support is enabled. ```bash void setSSLSupportSSL3( Boolean value ) ``` ### setSSLSupportSSL3ByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether SSLv3 support is enabled. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSupportSSL3ByLocation( String location Boolean value ) ``` ### setSSLSupportTLS1( value ) throws InvalidInput, DeploymentError Set whether TLSv1 support is enabled. ```bash void setSSLSupportTLS1( Boolean value ) ``` ### setSSLSupportTLS11( value ) throws InvalidInput, DeploymentError Set whether TLSv1.1 support is enabled. ```bash void setSSLSupportTLS11( Boolean value ) ``` ### setSSLSupportTLS11ByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether TLSv1.1 support is enabled. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSupportTLS11ByLocation( String location Boolean value ) ``` ### setSSLSupportTLS12( value ) throws InvalidInput, DeploymentError Set whether TLSv1.2 support is enabled. ```bash void setSSLSupportTLS12( Boolean value ) ``` ### setSSLSupportTLS12ByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether TLSv1.2 support is enabled. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSupportTLS12ByLocation( String location Boolean value ) ``` ### setSSLSupportTLS13( value ) throws InvalidInput, DeploymentError Set whether TLSv1.3 support is enabled. ```bash void setSSLSupportTLS13( Boolean value ) ``` ### setSSLSupportTLS13ByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether TLSv1.3 support is enabled. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSupportTLS13ByLocation( String location Boolean value ) ``` ### setSSLSupportTLS1ByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether TLSv1 support is enabled. This is a location specific function, any action will operate on the specified location. ```bash void setSSLSupportTLS1ByLocation( String location Boolean value ) ``` ### setSSLTicketsEnabled( value ) throws InvalidInput, DeploymentError Set whether use of session tickets is enabled, unless overridden by virtual server settings. ```bash void setSSLTicketsEnabled( Boolean value ) ``` ### setSSLTicketsEnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether use of session tickets is enabled, unless overridden by virtual server settings. This is a location specific function, any action will operate on the specified location. ```bash void setSSLTicketsEnabledByLocation( String location Boolean value ) ``` ### setSSLTicketsReissuePolicy( value ) throws InvalidInput, DeploymentError Set the SSL tickets reissue policy ```bash void setSSLTicketsReissuePolicy( GlobalSettings.SSLTicketsReissuePolicy value ) ``` ### setSSLTicketsTicketExpiry( value ) throws InvalidInput, DeploymentError Set the length of time for which an SSL session ticket will be accepted by a virtual server after the ticket is created. ```bash void setSSLTicketsTicketExpiry( Unsigned Integer value ) ``` ### setSSLTicketsTicketKeyExpiry( value ) throws InvalidInput, DeploymentError Set the length of time for which an auto-generated SSL ticket key will be used to decrypt old session tickets. ```bash void setSSLTicketsTicketKeyExpiry( Unsigned Integer value ) ``` ### setSSLTicketsTicketKeyRotation( value ) throws InvalidInput, DeploymentError Set the length of time for which an auto-generated SSL ticket key will be used to encrypt new session tickets. ```bash void setSSLTicketsTicketKeyRotation( Unsigned Integer value ) ``` ### setSSLTicketsTimeTolerance( value ) throws InvalidInput, DeploymentError Set the number of seconds to allow the current time to be outside the validity time of an SSL ticket before considering it invalid. ```bash void setSSLTicketsTimeTolerance( Unsigned Integer value ) ``` ### setSSLValidateServerCertificatesCatalog( value ) throws InvalidInput, DeploymentError Set whether SSL server certificates are validated. ```bash void setSSLValidateServerCertificatesCatalog( Boolean value ) ``` ### setSSLValidateServerCertificatesCatalogByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether SSL server certificates are validated. This is a location specific function, any action will operate on the specified location. ```bash void setSSLValidateServerCertificatesCatalogByLocation( String location Boolean value ) ``` ### setSharedPoolSize( value ) throws InvalidInput, DeploymentError Set is the size of shared memory pool to be used for shared storage across worker processes. ```bash void setSharedPoolSize( String value ) ``` ### setSharedPoolSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set is the size of shared memory pool to be used for shared storage across worker processes. This is a location specific function, any action will operate on the specified location. ```bash void setSharedPoolSizeByLocation( String location String value ) ``` ### setSoapIdleMinutes( value ) throws InvalidInput, DeploymentError Set the number of minutes the SOAP server remain idle before exiting ```bash void setSoapIdleMinutes( Unsigned Integer value ) ``` ### setSoapIdleMinutesByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of minutes the SOAP server remain idle before exiting This is a location specific function, any action will operate on the specified location. ```bash void setSoapIdleMinutesByLocation( String location Unsigned Integer value ) ``` ### setSocketOptimizations( value ) throws InvalidInput, DeploymentError Set whether potential network socket optimisations should be used. ```bash void setSocketOptimizations( GlobalSettings.SocketOptimizations value ) ``` ### setSocketOptimizationsByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether potential network socket optimisations should be used. This is a location specific function, any action will operate on the specified location. ```bash void setSocketOptimizationsByLocation( String location GlobalSettings.SocketOptimizations value ) ``` ### setSsldAccel( value ) throws InvalidInput, DeploymentError setSsldAccel is deprecated, please use setSSLHardwareAccelerator instead. ```bash void setSsldAccel( Boolean value ) ``` ### setSsldAccelByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist setSsldAccel is deprecated, please use setSSLHardwareAccelerator instead. This is a location specific function, any action will operate on the specified location. ```bash void setSsldAccelByLocation( String location Boolean value ) ``` ### setSsldLibrary( value ) throws InvalidInput, DeploymentError setSsldLibrary is deprecated, please use setSSLHardwareType instead. ```bash void setSsldLibrary( GlobalSettings.SsldLibrary value ) ``` ### setSsldLibraryByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist setSsldLibrary is deprecated, please use setSSLHardwareType instead. This is a location specific function, any action will operate on the specified location. ```bash void setSsldLibraryByLocation( String location GlobalSettings.SsldLibrary value ) ``` ### setStateSyncTime( value ) throws InvalidInput, DeploymentError Set how often the cache state is propagated to other traffic managers in the cluster, in seconds. ```bash void setStateSyncTime( Unsigned Integer value ) ``` ### setStateSyncTimeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set how often the cache state is propagated to other traffic managers in the cluster, in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setStateSyncTimeByLocation( String location Unsigned Integer value ) ``` ### setStateSyncTimeout( value ) throws InvalidInput, DeploymentError Set the timeout for state propagation between cluster members, in seconds ```bash void setStateSyncTimeout( Unsigned Integer value ) ``` ### setStateSyncTimeoutByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the timeout for state propagation between cluster members, in seconds This is a location specific function, any action will operate on the specified location. ```bash void setStateSyncTimeoutByLocation( String location Unsigned Integer value ) ``` ### setSystemReadBufferSize( value ) throws InvalidInput, DeploymentError Set the size of the operating system's read buffer, in bytes (0 means use the system default). ```bash void setSystemReadBufferSize( Unsigned Integer value ) ``` ### setSystemReadBufferSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the size of the operating system's read buffer, in bytes (0 means use the system default). This is a location specific function, any action will operate on the specified location. ```bash void setSystemReadBufferSizeByLocation( String location Unsigned Integer value ) ``` ### setSystemWriteBufferSize( value ) throws InvalidInput, DeploymentError Set the size of the operating system's write buffer, in bytes (0 means use the system default). ```bash void setSystemWriteBufferSize( Unsigned Integer value ) ``` ### setSystemWriteBufferSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the size of the operating system's write buffer, in bytes (0 means use the system default). This is a location specific function, any action will operate on the specified location. ```bash void setSystemWriteBufferSizeByLocation( String location Unsigned Integer value ) ``` ### setTelemetryEnabled( value ) throws InvalidInput, DeploymentError Set allow the reporting of anonymized usage data for product improvement and customer support purposes. ```bash void setTelemetryEnabled( Boolean value ) ``` ### setTelemetryEnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set allow the reporting of anonymized usage data for product improvement and customer support purposes. This is a location specific function, any action will operate on the specified location. ```bash void setTelemetryEnabledByLocation( String location Boolean value ) ``` ### setTrackUnknownUsers( value ) throws InvalidInput, DeploymentError Set whether to remember past login attempts from usernames that are not known to exist (should be No for an Admin Server accessible from the public Internet). ```bash void setTrackUnknownUsers( Boolean value ) ``` ### setTrafficIPGroupLimit( value ) throws InvalidInput, DeploymentError Set the maximum number of Traffic IP Groups allowed. ```bash void setTrafficIPGroupLimit( Unsigned Integer value ) ``` ### setTrafficIPGroupLimitByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of Traffic IP Groups allowed. This is a location specific function, any action will operate on the specified location. ```bash void setTrafficIPGroupLimitByLocation( String location Unsigned Integer value ) ``` ### setTrafficScriptExecutionTimeWarning( value ) throws InvalidInput, DeploymentError Set the number of milliseconds a rule can run for before a warning is logged. ```bash void setTrafficScriptExecutionTimeWarning( Unsigned Integer value ) ``` ### setTrafficScriptExecutionTimeWarningByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of milliseconds a rule can run for before a warning is logged. This is a location specific function, any action will operate on the specified location. ```bash void setTrafficScriptExecutionTimeWarningByLocation( String location Unsigned Integer value ) ``` ### setTrafficScriptMemoryWarning( value ) throws InvalidInput, DeploymentError Set the amount of buffered network data a TrafficScript rule can buffer before a warning is logged, in bytes. ```bash void setTrafficScriptMemoryWarning( Unsigned Integer value ) ``` ### setTrafficScriptMemoryWarningByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the amount of buffered network data a TrafficScript rule can buffer before a warning is logged, in bytes. This is a location specific function, any action will operate on the specified location. ```bash void setTrafficScriptMemoryWarningByLocation( String location Unsigned Integer value ) ``` ### setTrafficscriptArrayElements( value ) throws InvalidInput, DeploymentError This method is now obsolete. ```bash void setTrafficscriptArrayElements( Unsigned Integer value ) ``` ### setTrafficscriptArrayElementsByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist This method is now obsolete. ```bash void setTrafficscriptArrayElementsByLocation( String location Unsigned Integer value ) ``` ### setTrafficscriptDataLocalSize( value ) throws InvalidInput, DeploymentError Set the maximum size of the TrafficScript local data pool (specified as a percentage of system RAM, e.g. '5%', or an absolute size, e.g. 200MB) ```bash void setTrafficscriptDataLocalSize( String value ) ``` ### setTrafficscriptDataLocalSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum size of the TrafficScript local data pool (specified as a percentage of system RAM, e.g. '5%', or an absolute size, e.g. 200MB) This is a location specific function, any action will operate on the specified location. ```bash void setTrafficscriptDataLocalSizeByLocation( String location String value ) ``` ### setTrafficscriptDataSize( value ) throws InvalidInput, DeploymentError Set the maximum size of the TrafficScript shared data pool (specified as a percentage of system RAM, e.g. '5%', or an absolute size, e.g. 200MB) ```bash void setTrafficscriptDataSize( String value ) ``` ### setTrafficscriptDataSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum size of the TrafficScript shared data pool (specified as a percentage of system RAM, e.g. '5%', or an absolute size, e.g. 200MB) This is a location specific function, any action will operate on the specified location. ```bash void setTrafficscriptDataSizeByLocation( String location String value ) ``` ### setTrafficscriptMaxInstr( value ) throws InvalidInput, DeploymentError Set the maximum number of instructions a TrafficScript rule will run before being aborted. ```bash void setTrafficscriptMaxInstr( Unsigned Integer value ) ``` ### setTrafficscriptMaxInstrByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of instructions a TrafficScript rule will run before being aborted. This is a location specific function, any action will operate on the specified location. ```bash void setTrafficscriptMaxInstrByLocation( String location Unsigned Integer value ) ``` ### setTrafficscriptRegexCacheSize( value ) throws InvalidInput, DeploymentError Set the number of regular expressions to cache ```bash void setTrafficscriptRegexCacheSize( Unsigned Integer value ) ``` ### setTrafficscriptRegexCacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the number of regular expressions to cache This is a location specific function, any action will operate on the specified location. ```bash void setTrafficscriptRegexCacheSizeByLocation( String location Unsigned Integer value ) ``` ### setTrafficscriptRegexMatchLimit( value ) throws InvalidInput, DeploymentError Set the maximum number of ways TrafficScript will attempt to match a regular expression at each position in the subject string, before it aborts the rule and reports a TrafficScript error. ```bash void setTrafficscriptRegexMatchLimit( Unsigned Integer value ) ``` ### setTrafficscriptRegexMatchLimitByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of ways TrafficScript will attempt to match a regular expression at each position in the subject string, before it aborts the rule and reports a TrafficScript error. This is a location specific function, any action will operate on the specified location. ```bash void setTrafficscriptRegexMatchLimitByLocation( String location Unsigned Integer value ) ``` ### setTrafficscriptRegexMatchWarnPerc( value ) throws InvalidInput, DeploymentError Set the percentage of trafficscript!regex\_match\_limit at which TrafficScript reports a performance warning. ```bash void setTrafficscriptRegexMatchWarnPerc( Unsigned Integer value ) ``` ### setTrafficscriptRegexMatchWarnPercByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the percentage of trafficscript!regex\_match\_limit at which TrafficScript reports a performance warning. This is a location specific function, any action will operate on the specified location. ```bash void setTrafficscriptRegexMatchWarnPercByLocation( String location Unsigned Integer value ) ``` ### setTrafficscriptVariablePoolUse( value ) throws InvalidInput, DeploymentError Set whether the 'pool.use' and 'pool.select' TrafficScript functions accept variables as well as literal strings. ```bash void setTrafficscriptVariablePoolUse( Boolean value ) ``` ### setTrafficscriptVariablePoolUseByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the 'pool.use' and 'pool.select' TrafficScript functions accept variables as well as literal strings. This is a location specific function, any action will operate on the specified location. ```bash void setTrafficscriptVariablePoolUseByLocation( String location Boolean value ) ``` ### setTransactionExportEnabled( value ) throws InvalidInput, DeploymentError Set whether to export metadata about transactions processed by the traffic manager to an external location. ```bash void setTransactionExportEnabled( Boolean value ) ``` ### setTransactionExportEnabledByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether to export metadata about transactions processed by the traffic manager to an external location. This is a location specific function, any action will operate on the specified location. ```bash void setTransactionExportEnabledByLocation( String location Boolean value ) ``` ### setTransactionExportEndpoint( value ) throws InvalidInput, DeploymentError Set the endpoint to which transaction metadata should be exported. ```bash void setTransactionExportEndpoint( String value ) ``` ### setTransactionExportEndpointByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the endpoint to which transaction metadata should be exported. This is a location specific function, any action will operate on the specified location. ```bash void setTransactionExportEndpointByLocation( String location String value ) ``` ### setTransactionExportTLS( value ) throws InvalidInput, DeploymentError Set whether the connection to the specified endpoint should be encrypted. ```bash void setTransactionExportTLS( Boolean value ) ``` ### setTransactionExportTLSByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the connection to the specified endpoint should be encrypted. This is a location specific function, any action will operate on the specified location. ```bash void setTransactionExportTLSByLocation( String location Boolean value ) ``` ### setTransactionExportTLSVerify( value ) throws InvalidInput, DeploymentError Set whether the server certificate presented by the endpoint should be verified, preventing a connection from being established if the certificate does not match the server name, is self-signed, is expired, is revoked, or has an unknown CA. ```bash void setTransactionExportTLSVerify( Boolean value ) ``` ### setTransactionExportTLSVerifyByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the server certificate presented by the endpoint should be verified, preventing a connection from being established if the certificate does not match the server name, is self-signed, is expired, is revoked, or has an unknown CA. This is a location specific function, any action will operate on the specified location. ```bash void setTransactionExportTLSVerifyByLocation( String location Boolean value ) ``` ### setUDPReadMultiple( value ) throws InvalidInput, DeploymentError Set whether your traffic manager should try to read multiple UDP packets from clients each time the kernel reports data received from clients. ```bash void setUDPReadMultiple( Boolean value ) ``` ### setUDPReadMultipleByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether your traffic manager should try to read multiple UDP packets from clients each time the kernel reports data received from clients. This is a location specific function, any action will operate on the specified location. ```bash void setUDPReadMultipleByLocation( String location Boolean value ) ``` ### setUipageBanner( value ) throws InvalidInput, DeploymentError Set the banner text to be displayed on all Admin Server pages. ```bash void setUipageBanner( String value ) ``` ### setUniversalSessionCacheExpiry( value ) throws InvalidInput, DeploymentError Set universal session cache expiry time in seconds. ```bash void setUniversalSessionCacheExpiry( Unsigned Integer value ) ``` ### setUniversalSessionCacheExpiryByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set universal session cache expiry time in seconds. This is a location specific function, any action will operate on the specified location. ```bash void setUniversalSessionCacheExpiryByLocation( String location Unsigned Integer value ) ``` ### setUniversalSessionCacheSize( value ) throws InvalidInput, DeploymentError Set the maximum number of entries in the universal session cache. ```bash void setUniversalSessionCacheSize( Unsigned Integer value ) ``` ### setUniversalSessionCacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of entries in the universal session cache. This is a location specific function, any action will operate on the specified location. ```bash void setUniversalSessionCacheSizeByLocation( String location Unsigned Integer value ) ``` ### setWatchdogTimeout( value ) throws InvalidInput, DeploymentError Set the maximum time in seconds a process can fail to update its heartbeat, before the watchdog considers it to have stalled. ```bash void setWatchdogTimeout( Unsigned Integer value ) ``` ### setWatchdogTimeoutByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum time in seconds a process can fail to update its heartbeat, before the watchdog considers it to have stalled. This is a location specific function, any action will operate on the specified location. ```bash void setWatchdogTimeoutByLocation( String location Unsigned Integer value ) ``` ### setWebcacheAvgPathLength( value ) throws InvalidInput, DeploymentError Set the estimated average length of the path for resources to be cached ```bash void setWebcacheAvgPathLength( Unsigned Integer value ) ``` ### setWebcacheAvgPathLengthByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the estimated average length of the path for resources to be cached This is a location specific function, any action will operate on the specified location. ```bash void setWebcacheAvgPathLengthByLocation( String location Unsigned Integer value ) ``` ### setWebcacheDisk( value ) throws InvalidInput, DeploymentError Set whether the webcache is stored on disk ```bash void setWebcacheDisk( Boolean value ) ``` ### setWebcacheDiskByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the webcache is stored on disk This is a location specific function, any action will operate on the specified location. ```bash void setWebcacheDiskByLocation( String location Boolean value ) ``` ### setWebcacheDiskDir( value ) throws InvalidInput, DeploymentError Set the disk cache location ```bash void setWebcacheDiskDir( String value ) ``` ### setWebcacheDiskDirByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the disk cache location This is a location specific function, any action will operate on the specified location. ```bash void setWebcacheDiskDirByLocation( String location String value ) ``` ### setWebcacheMaxFileNum( value ) throws InvalidInput, DeploymentError Set the maximum number of files that can be stored in the web cache ```bash void setWebcacheMaxFileNum( Unsigned Integer value ) ``` ### setWebcacheMaxFileNumByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum number of files that can be stored in the web cache This is a location specific function, any action will operate on the specified location. ```bash void setWebcacheMaxFileNumByLocation( String location Unsigned Integer value ) ``` ### setWebcacheMaxFileSize( value ) throws InvalidInput, DeploymentError Set the largest size of a cacheable object, relative to the total cache size, e.g. '2%', or as an absolute size in kB (default), MB or GB, e.g. '20MB'. ```bash void setWebcacheMaxFileSize( String value ) ``` ### setWebcacheMaxFileSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the largest size of a cacheable object, relative to the total cache size, e.g. '2%', or as an absolute size in kB (default), MB or GB, e.g. '20MB'. This is a location specific function, any action will operate on the specified location. ```bash void setWebcacheMaxFileSizeByLocation( String location String value ) ``` ### setWebcacheMaxPathLength( value ) throws InvalidInput, DeploymentError Set the maximum length of the path for the resource being cached ```bash void setWebcacheMaxPathLength( Unsigned Integer value ) ``` ### setWebcacheMaxPathLengthByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum length of the path for the resource being cached This is a location specific function, any action will operate on the specified location. ```bash void setWebcacheMaxPathLengthByLocation( String location Unsigned Integer value ) ``` ### setWebcacheNormalizeQuery( value ) throws InvalidInput, DeploymentError Set whether the assignment sub-strings in the parameter string are put into alphabetical order. ```bash void setWebcacheNormalizeQuery( Boolean value ) ``` ### setWebcacheNormalizeQueryByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether the assignment sub-strings in the parameter string are put into alphabetical order. This is a location specific function, any action will operate on the specified location. ```bash void setWebcacheNormalizeQueryByLocation( String location Boolean value ) ``` ### setWebcacheSize( value ) throws InvalidInput, DeploymentError Set the maximum size of the HTTP web page cache, (specified as a percentage of system RAM, e.g. '20%', or an absolute size, e.g. 200MB) ```bash void setWebcacheSize( String value ) ``` ### setWebcacheSizeByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set the maximum size of the HTTP web page cache, (specified as a percentage of system RAM, e.g. '20%', or an absolute size, e.g. 200MB) This is a location specific function, any action will operate on the specified location. ```bash void setWebcacheSizeByLocation( String location String value ) ``` ### setWebcacheVerbose( value ) throws InvalidInput, DeploymentError Set whether an X-Cache-Info header to show cacheability should be added. ```bash void setWebcacheVerbose( Boolean value ) ``` ### setWebcacheVerboseByLocation( location, value ) throws InvalidInput, DeploymentError, ObjectDoesNotExist Set whether an X-Cache-Info header to show cacheability should be added. This is a location specific function, any action will operate on the specified location. ```bash void setWebcacheVerboseByLocation( String location Boolean value ) ``` ### Structures ### GlobalSettings.ReturnPathRoute This structure contains a return path route, consisting of MAC + IPv4 + IPv6 addresses. At least one IP address is required. ```bash struct GlobalSettings.ReturnPathRoute { # The MAC address of the router. String mac; # The IPv4 address of the router. String ipv4; # The IPv6 address of the router. String ipv6; } ``` ### Enumerations ### GlobalSettings.AdminAllowRehandshake ```bash enum GlobalSettings.AdminAllowRehandshake { # Always allow always, # Allow safe re-handshakes safe, # Only if client uses RFC 5746 (Secure Renegotiation Extension) rfc5746, # Never allow never } ``` ### GlobalSettings.AdminDiffieHellmanKeyLength ```bash enum GlobalSettings.AdminDiffieHellmanKeyLength { # 1024 dh_1024, # 2048 dh_2048, # 3072 dh_3072, # 4096 dh_4096 } ``` ### GlobalSettings.DataPlaneAccelerationCores ```bash enum GlobalSettings.DataPlaneAccelerationCores { # 1 One, # 2 Two, # 4 Four } ``` ### GlobalSettings.ErrorLevel ```bash enum GlobalSettings.ErrorLevel { # ERR_FATAL fatal, # ERR_SERIOUS serious, # ERR_WARN warn, # ERR_INFO info } ``` ### GlobalSettings.FlipperHeartbeatMethod ```bash enum GlobalSettings.FlipperHeartbeatMethod { # multicast multicast, # unicast unicast } ``` ### GlobalSettings.LogExportAuthHTTP ```bash enum GlobalSettings.LogExportAuthHTTP { # None none, # Basic (Username and Password) basic, # Splunk (HEC token) splunk } ``` ### GlobalSettings.Ospfv2AreaType ```bash enum GlobalSettings.Ospfv2AreaType { # Normal area normal, # Stub area stub, # Not So Stubby Area (RFC3101) nssa } ``` ### GlobalSettings.SSL3AllowRehandshake ```bash enum GlobalSettings.SSL3AllowRehandshake { # Always allow always, # Allow safe re-handshakes safe, # Only if client uses RFC 5746 (Secure Renegotiation Extension) rfc5746, # Never allow never } ``` ### GlobalSettings.SSL3DiffieHellmanKeyLength ```bash enum GlobalSettings.SSL3DiffieHellmanKeyLength { # 1024 dh_1024, # 2048 dh_2048, # 3072 dh_3072, # 4096 dh_4096 } ``` ### GlobalSettings.SSLAllowRehandshake ```bash enum GlobalSettings.SSLAllowRehandshake { # Always allow always, # Allow safe re-handshakes safe, # Only if client uses RFC 5746 (Secure Renegotiation Extension) rfc5746, # Never allow never } ``` ### GlobalSettings.SSLDiffieHellmanModulusSize ```bash enum GlobalSettings.SSLDiffieHellmanModulusSize { # 1024 dh_1024, # 2048 dh_2048, # 3072 dh_3072, # 4096 dh_4096 } ``` ### GlobalSettings.SSLHardwarePKCS11SlotType ```bash enum GlobalSettings.SSLHardwarePKCS11SlotType { # Operator Card Set operator, # Soft Card softcard, # Module Protected module } ``` ### GlobalSettings.SSLHardwareType ```bash enum GlobalSettings.SSLHardwareType { # None none, # PKCS#11 pkcs11, # Microsoft Azure Key Vault azure } ``` ### GlobalSettings.SSLTicketsReissuePolicy ```bash enum GlobalSettings.SSLTicketsReissuePolicy { # always always, # never never } ``` ### GlobalSettings.SocketOptimizations ```bash enum GlobalSettings.SocketOptimizations { # auto auto, # Yes Yes, # No No } ``` ### GlobalSettings.SsldLibrary ```bash enum GlobalSettings.SsldLibrary { # None none, # PKCS#11 pkcs11, # Microsoft Azure Key Vault azure } ```