VirtualServer
URI: http://soap.zeus.com/zxtm/1.0/VirtualServer/
The VirtualServer interface allows management of Virtual Server objects. Using this interface, you can create, delete and rename virtual server objects, and manage their configuration.
Methods
addCASites( names, ca_sites ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Adds the specified CASite objects to the named virtual servers. These objects are mappings between hostname or IP addresses and the settings used to check client certificates.
void addCASites(
String[] names
VirtualServer.CASite[][] ca_sites
)addCompletionRules( names, rules ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add new rules to be run on the completion of a transaction for each of the named virtual servers. New rules are run after existing rules. If any of the rules are already configured to run, then they are enabled and flags are set to the values passed in.
void addCompletionRules(
String[] names
VirtualServer.Rule[][] rules
)addCompletionRulesByLocation( location, names, rules ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add new rules to be run on the completion of a transaction for each of the named virtual servers. New rules are run after existing rules. If any of the rules are already configured to run, then they are enabled and flags are set to the values passed in. This is a location specific function, any action will operate on the specified location.
void addCompletionRulesByLocation(
String location
String[] names
VirtualServer.Rule[][] rules
)addCompressionMIMETypes( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
For each named virtual server, add new MIME types to the list of types to compress.
void addCompressionMIMETypes(
String[] names
String[][] values
)addCompressionMIMETypesByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
For each named virtual server, add new MIME types to the list of types to compress. This is a location specific function, any action will operate on the specified location.
void addCompressionMIMETypesByLocation(
String location
String[] names
String[][] values
)addDNSZones( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add Space separated list of DNS zones
void addDNSZones(
String[] names
String[][] values
)addDNSZonesByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add Space separated list of DNS zones This is a location specific function, any action will operate on the specified location.
void addDNSZonesByLocation(
String location
String[] names
String[][] values
)addGLBServices( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add GLB Services used by the virtual server
void addGLBServices(
String[] names
String[][] values
)addGLBServicesByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add GLB Services used by the virtual server This is a location specific function, any action will operate on the specified location.
void addGLBServicesByLocation(
String location
String[] names
String[][] values
)addHTTP2HeadersIndexBlacklist( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add a list of header names that should never be compressed using indexing.
void addHTTP2HeadersIndexBlacklist(
String[] names
String[][] values
)addHTTP2HeadersIndexBlacklistByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add a list of header names that should never be compressed using indexing. This is a location specific function, any action will operate on the specified location.
void addHTTP2HeadersIndexBlacklistByLocation(
String location
String[] names
String[][] values
)addHTTP2HeadersIndexWhitelist( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add a list of header names that can be compressed using indexing when the default is to never index.
void addHTTP2HeadersIndexWhitelist(
String[] names
String[][] values
)addHTTP2HeadersIndexWhitelistByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add a list of header names that can be compressed using indexing when the default is to never index. This is a location specific function, any action will operate on the specified location.
void addHTTP2HeadersIndexWhitelistByLocation(
String location
String[] names
String[][] values
)addResponseRules( names, rules ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add new rules to be run on server responses for each of the named virtual servers. New rules are run after existing rules. If any of the rules are already configured to run, then they are enabled and flags are set to the values passed in.
void addResponseRules(
String[] names
VirtualServer.Rule[][] rules
)addResponseRulesByLocation( location, names, rules ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add new rules to be run on server responses for each of the named virtual servers. New rules are run after existing rules. If any of the rules are already configured to run, then they are enabled and flags are set to the values passed in. This is a location specific function, any action will operate on the specified location.
void addResponseRulesByLocation(
String location
String[] names
VirtualServer.Rule[][] rules
)addRules( names, rules ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add new rules to be run on client requests for each of the named virtual servers. New rules are run after existing rules. If any of the rules are already configured to run, then they are enabled and flags are set to the values passed in.
void addRules(
String[] names
VirtualServer.Rule[][] rules
)addRulesByLocation( location, names, rules ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add new rules to be run on client requests for each of the named virtual servers. New rules are run after existing rules. If any of the rules are already configured to run, then they are enabled and flags are set to the values passed in. This is a location specific function, any action will operate on the specified location.
void addRulesByLocation(
String location
String[] names
VirtualServer.Rule[][] rules
)addSSLClientCertificateAuthorities( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add new certificate authorities for validating client certificates for each of the named virtual servers.
void addSSLClientCertificateAuthorities(
String[] names
String[][] values
)addSSLClientCertificateAuthoritiesByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add new certificate authorities for validating client certificates for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void addSSLClientCertificateAuthoritiesByLocation(
String location
String[] names
String[][] values
)addSSLNeverExpiringClientCertificateAuthorities( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add CAs for which any client certificate they validate is considered valid even if the client certificate's expiration date has passed, for each of the named virtual servers.
void addSSLNeverExpiringClientCertificateAuthorities(
String[] names
String[][] values
)addSSLNeverExpiringClientCertificateAuthoritiesByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add CAs for which any client certificate they validate is considered valid even if the client certificate's expiration date has passed, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void addSSLNeverExpiringClientCertificateAuthoritiesByLocation(
String location
String[] names
String[][] values
)addSSLOCSPIssuers( names, ssl_ocsp_issuers ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Adds mappings between Certificate Authorities and OCSP responder settings. Certificates issued by these authorities will be verified with OCSP using these settings.
void addSSLOCSPIssuers(
String[] names
VirtualServer.SSLOCSPIssuer[][] ssl_ocsp_issuers
)addSSLOCSPIssuersByLocation( location, names, ssl_ocsp_issuers ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Adds mappings between Certificate Authorities and OCSP responder settings. Certificates issued by these authorities will be verified with OCSP using these settings. This is a location specific function, any action will operate on the specified location.
void addSSLOCSPIssuersByLocation(
String location
String[] names
VirtualServer.SSLOCSPIssuer[][] ssl_ocsp_issuers
)addSSLSites( names, ssl_sites ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Adds the specified SSLSite objects to the named virtual servers. These objects are mappings between destination addresses and the certificate used for SSL decryption those addresses. Each certificate is the name of an item in the SSL Certificates Catalog.
void addSSLSites(
String[] names
VirtualServer.SSLSite[][] ssl_sites
)addSSLSitesByLocation( location, names, ssl_sites ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Adds the specified SSLSite objects to the named virtual servers. These objects are mappings between destination addresses and the certificate used for SSL decryption those addresses. Each certificate is the name of an item in the SSL Certificates Catalog. This is a location specific function, any action will operate on the specified location.
void addSSLSitesByLocation(
String location
String[] names
VirtualServer.SSLSite[][] ssl_sites
)addSSLSitesEx( names, ssl_sites ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Adds the specified SSLSiteAlt objects to the named virtual servers. These objects are mappings between destination addresses and the certificates used for SSL decryption those addresses. Each certificate is the name of an item in the SSL Certificates Catalog.
void addSSLSitesEx(
String[] names
VirtualServer.SSLSiteAlt[][] ssl_sites
)addSSLSitesExByLocation( location, names, ssl_sites ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Adds the specified SSLSiteAlt objects to the named virtual servers. These objects are mappings between destination addresses and the certificates used for SSL decryption those addresses. Each certificate is the name of an item in the SSL Certificates Catalog. This is a location specific function, any action will operate on the specified location.
void addSSLSitesExByLocation(
String location
String[] names
VirtualServer.SSLSiteAlt[][] ssl_sites
)addTransactionExportHTTPHeaderBlacklist( names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add the set of HTTP header names for which corresponding values should be redacted from the metadata exported by this virtual server. from transaction export.
void addTransactionExportHTTPHeaderBlacklist(
String[] names
String[][] values
)addTransactionExportHTTPHeaderBlacklistByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Add the set of HTTP header names for which corresponding values should be redacted from the metadata exported by this virtual server. from transaction export. This is a location specific function, any action will operate on the specified location.
void addTransactionExportHTTPHeaderBlacklistByLocation(
String location
String[] names
String[][] values
)addVirtualServer( names, info ) throws ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidInput
Add each virtual servers, using the provided BasicInfo.
void addVirtualServer(
String[] names
VirtualServer.BasicInfo[] info
)copyVirtualServer( names, new_names ) throws ObjectAlreadyExists, ObjectDoesNotExist, InvalidObjectName, DeploymentError
Rename each of the named virtual servers.
void copyVirtualServer(
String[] names
String[] new_names
)deleteCASites( names, host_or_ips ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Deletes the CASite objects that give the hostname- or IP address-specific settings for each of the named virtual servers. The host_or_ips array lists the mappings to be removed for each virtual server.
void deleteCASites(
String[] names
String[][] host_or_ips
)deleteSSLSites( names, site_ips ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Deletes the SSLSite objects that act on the IP addresses in the site_ips array for each of the named virtual servers. These objects are mappings between destination addresses and the certificate used for SSL decryption those addresses. Each certificate is the name of an item in the SSL Certificates Catalog.
void deleteSSLSites(
String[] names
String[][] site_ips
)deleteSSLSitesByLocation( location, names, site_ips ) throws ObjectDoesNotExist, DeploymentError, InvalidInput
Deletes the SSLSite objects that act on the IP addresses in the site_ips array for each of the named virtual servers. These objects are mappings between destination addresses and the certificate used for SSL decryption those addresses. Each certificate is the name of an item in the SSL Certificates Catalog. This is a location specific function, any action will operate on the specified location.
void deleteSSLSitesByLocation(
String location
String[] names
String[][] site_ips
)deleteVirtualServer( names ) throws ObjectDoesNotExist, DeploymentError
Delete each of the named virtual servers.
void deleteVirtualServer(
String[] names
)editCASites( names, host_or_ips, ca_sites ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Edits the CASite objects that give the hostname- or IP address-specific settings for client certificate checking for each of the named virtual servers.
void editCASites(
String[] names
String[][] host_or_ips
VirtualServer.CASite[][] ca_sites
)editSSLSites( names, site_ips, ssl_sites ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Edits the SSLSite objects that act on the IP addresses in the site_ips array for each of the named virtual servers. These objects are mappings between destination addresses and the certificate used for SSL decryption those addresses. Each certificate is the name of an item in the SSL Certificates Catalog.
void editSSLSites(
String[] names
String[][] site_ips
VirtualServer.SSLSite[][] ssl_sites
)editSSLSitesByLocation( location, names, site_ips, ssl_sites ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Edits the SSLSite objects that act on the IP addresses in the site_ips array for each of the named virtual servers. These objects are mappings between destination addresses and the certificate used for SSL decryption those addresses. Each certificate is the name of an item in the SSL Certificates Catalog. This is a location specific function, any action will operate on the specified location.
void editSSLSitesByLocation(
String location
String[] names
String[][] site_ips
VirtualServer.SSLSite[][] ssl_sites
)editSSLSitesEx( names, site_ips, ssl_sites ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Edits the SSLSite objects that act on the IP addresses in the site_ips array for each of the named virtual servers. These objects are mappings between destination addresses and the certificates used for SSL decryption those addresses. Each certificate is the name of an item in the SSL Certificates Catalog.
void editSSLSitesEx(
String[] names
String[][] site_ips
VirtualServer.SSLSiteAlt[][] ssl_sites
)editSSLSitesExByLocation( location, names, site_ips, ssl_sites ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Edits the SSLSite objects that act on the IP addresses in the site_ips array for each of the named virtual servers. These objects are mappings between destination addresses and the certificates used for SSL decryption those addresses. Each certificate is the name of an item in the SSL Certificates Catalog. This is a location specific function, any action will operate on the specified location.
void editSSLSitesExByLocation(
String location
String[] names
String[][] site_ips
VirtualServer.SSLSiteAlt[][] ssl_sites
)getAddClusterClientIPHeader( names ) throws ObjectDoesNotExist
Get whether an 'X-Cluster-Client-Ip' header should be added to each HTTP request, for each of the named virtual servers. The 'X-Cluster-Client-Ip' header contains the client's IP address.
Boolean[] getAddClusterClientIPHeader(
String[] names
)getAddClusterClientIPHeaderByLocation( location, names ) throws ObjectDoesNotExist
Get whether an 'X-Cluster-Client-Ip' header should be added to each HTTP request, for each of the named virtual servers. The 'X-Cluster-Client-Ip' header contains the client's IP address. This is a location specific function, any action will operate on the specified location.
Boolean[] getAddClusterClientIPHeaderByLocation(
String location
String[] names
)getAddXForwardedForHeader( names ) throws ObjectDoesNotExist
Get whether the remote client's IP address should be appended to the X-Forwarded-For header. The 'X-Forwarded-For' header contains the client's IP address.
Boolean[] getAddXForwardedForHeader(
String[] names
)getAddXForwardedForHeaderByLocation( location, names ) throws ObjectDoesNotExist
Get whether the remote client's IP address should be appended to the X-Forwarded-For header. The 'X-Forwarded-For' header contains the client's IP address. This is a location specific function, any action will operate on the specified location.
Boolean[] getAddXForwardedForHeaderByLocation(
String location
String[] names
)getAddXForwardedProtoHeader( names ) throws ObjectDoesNotExist
Get whether an 'X-Forwarded-Proto' header should be added to each HTTP request, for each of the named virtual servers. The 'X-Forwarded-Proto' header contains the protocol the client used to connect to the traffic manager
Boolean[] getAddXForwardedProtoHeader(
String[] names
)getAddXForwardedProtoHeaderByLocation( location, names ) throws ObjectDoesNotExist
Get whether an 'X-Forwarded-Proto' header should be added to each HTTP request, for each of the named virtual servers. The 'X-Forwarded-Proto' header contains the protocol the client used to connect to the traffic manager This is a location specific function, any action will operate on the specified location.
Boolean[] getAddXForwardedProtoHeaderByLocation(
String location
String[] names
)getAptimizerEnabled( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should optimize web content.
Boolean[] getAptimizerEnabled(
String[] names
)getAptimizerEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should optimize web content. This is a location specific function, any action will operate on the specified location.
Boolean[] getAptimizerEnabledByLocation(
String location
String[] names
)getAuthSamlIdp( names ) throws ObjectDoesNotExist
Get the name of the Trusted Identity Provider configuration to use.
String[] getAuthSamlIdp(
String[] names
)getAuthSamlIdpByLocation( location, names ) throws ObjectDoesNotExist
Get the name of the Trusted Identity Provider configuration to use. This is a location specific function, any action will operate on the specified location.
String[] getAuthSamlIdpByLocation(
String location
String[] names
)getAuthSamlNameIdFormat( names ) throws ObjectDoesNotExist
Get the desired nameid format.
VirtualServer.AuthSamlNameIdFormat[] getAuthSamlNameIdFormat(
String[] names
)getAuthSamlNameIdFormatByLocation( location, names ) throws ObjectDoesNotExist
Get the desired nameid format. This is a location specific function, any action will operate on the specified location.
VirtualServer.AuthSamlNameIdFormat[] getAuthSamlNameIdFormatByLocation(
String location
String[] names
)getAuthSamlSpAcsUrl( names ) throws ObjectDoesNotExist
Get the URL of the assertion consumer service.
String[] getAuthSamlSpAcsUrl(
String[] names
)getAuthSamlSpAcsUrlByLocation( location, names ) throws ObjectDoesNotExist
Get the URL of the assertion consumer service. This is a location specific function, any action will operate on the specified location.
String[] getAuthSamlSpAcsUrlByLocation(
String location
String[] names
)getAuthSamlSpEntityId( names ) throws ObjectDoesNotExist
Get the entity id of this service provider.
String[] getAuthSamlSpEntityId(
String[] names
)getAuthSamlSpEntityIdByLocation( location, names ) throws ObjectDoesNotExist
Get the entity id of this service provider. This is a location specific function, any action will operate on the specified location.
String[] getAuthSamlSpEntityIdByLocation(
String location
String[] names
)getAuthSamlTimeTolerance( names ) throws ObjectDoesNotExist
Get the time tolerance on authentication checks (in seconds)
Unsigned Integer[] getAuthSamlTimeTolerance(
String[] names
)getAuthSamlTimeToleranceByLocation( location, names ) throws ObjectDoesNotExist
Get the time tolerance on authentication checks (in seconds) This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAuthSamlTimeToleranceByLocation(
String location
String[] names
)getAuthSessionCookieAttributes( names ) throws ObjectDoesNotExist
Get the attributes of the cookie used for the authentication session.
String[] getAuthSessionCookieAttributes(
String[] names
)getAuthSessionCookieAttributesByLocation( location, names ) throws ObjectDoesNotExist
Get the attributes of the cookie used for the authentication session. This is a location specific function, any action will operate on the specified location.
String[] getAuthSessionCookieAttributesByLocation(
String location
String[] names
)getAuthSessionCookieName( names ) throws ObjectDoesNotExist
Get the name of the cookie used for the authentication session.
String[] getAuthSessionCookieName(
String[] names
)getAuthSessionCookieNameByLocation( location, names ) throws ObjectDoesNotExist
Get the name of the cookie used for the authentication session. This is a location specific function, any action will operate on the specified location.
String[] getAuthSessionCookieNameByLocation(
String location
String[] names
)getAuthSessionLogExternalState( names ) throws ObjectDoesNotExist
Get plaintext logging of encrypted authentication session state
Boolean[] getAuthSessionLogExternalState(
String[] names
)getAuthSessionLogExternalStateByLocation( location, names ) throws ObjectDoesNotExist
Get plaintext logging of encrypted authentication session state This is a location specific function, any action will operate on the specified location.
Boolean[] getAuthSessionLogExternalStateByLocation(
String location
String[] names
)getAuthSessionTimeout( names ) throws ObjectDoesNotExist
Get the authentication session timeout (in seconds)
Unsigned Integer[] getAuthSessionTimeout(
String[] names
)getAuthSessionTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the authentication session timeout (in seconds) This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getAuthSessionTimeoutByLocation(
String location
String[] names
)getAuthType( names ) throws ObjectDoesNotExist
Get the type of authentication to apply to requests to the virtual server.
VirtualServer.AuthType[] getAuthType(
String[] names
)getAuthTypeByLocation( location, names ) throws ObjectDoesNotExist
Get the type of authentication to apply to requests to the virtual server. This is a location specific function, any action will operate on the specified location.
VirtualServer.AuthType[] getAuthTypeByLocation(
String location
String[] names
)getAuthVerbose( names ) throws ObjectDoesNotExist
Get whether vserver authentication events should be logged in detail
Boolean[] getAuthVerbose(
String[] names
)getAuthVerboseByLocation( location, names ) throws ObjectDoesNotExist
Get whether vserver authentication events should be logged in detail This is a location specific function, any action will operate on the specified location.
Boolean[] getAuthVerboseByLocation(
String location
String[] names
)getAutodetectUpgradeHeaders( names ) throws ObjectDoesNotExist
Get whether the traffic manager should check for HTTP responses that confirm an upgrade to the WebSockets protocol and automatically stop any protocol-specific processing for that connection when detected.
Boolean[] getAutodetectUpgradeHeaders(
String[] names
)getAutodetectUpgradeHeadersByLocation( location, names ) throws ObjectDoesNotExist
Get whether the traffic manager should check for HTTP responses that confirm an upgrade to the WebSockets protocol and automatically stop any protocol-specific processing for that connection when detected. This is a location specific function, any action will operate on the specified location.
Boolean[] getAutodetectUpgradeHeadersByLocation(
String location
String[] names
)getBandwidthClass( names ) throws ObjectDoesNotExist
Get the Bandwidth Class that each of the named virtual servers uses.
String[] getBandwidthClass(
String[] names
)getBandwidthClassByLocation( location, names ) throws ObjectDoesNotExist
Get the Bandwidth Class that each of the named virtual servers uses. This is a location specific function, any action will operate on the specified location.
String[] getBandwidthClassByLocation(
String location
String[] names
)getBasicInfo( names ) throws ObjectDoesNotExist
Get the basic information for each of the named virtual servers. This information includes the port, the protocol the virtual server handles and the default pool for the traffic.
VirtualServer.BasicInfo[] getBasicInfo(
String[] names
)getBasicInfoByLocation( location, names ) throws ObjectDoesNotExist
Get the basic information for each of the named virtual servers. This information includes the port, the protocol the virtual server handles and the default pool for the traffic. This is a location specific function, any action will operate on the specified location.
VirtualServer.BasicInfo[] getBasicInfoByLocation(
String location
String[] names
)getBypassDataPlaneAcceleration( names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getBypassDataPlaneAcceleration(
String[] names
)getBypassDataPlaneAccelerationByLocation( location, names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getBypassDataPlaneAccelerationByLocation(
String location
String[] names
)getCASites( names ) throws ObjectDoesNotExist
Gets a list of mappings between hostnames or IP addresses and the settings used to check client certificates, for each of the named virtual servers.
VirtualServer.CASite[][] getCASites(
String[] names
)getCloseWithRst( names ) throws ObjectDoesNotExist
Get whether connections from clients should be closed with a RST packet, rather than a FIN packet, avoiding the TIME_WAIT state.
Boolean[] getCloseWithRst(
String[] names
)getCloseWithRstByLocation( location, names ) throws ObjectDoesNotExist
Get whether connections from clients should be closed with a RST packet, rather than a FIN packet, avoiding the TIME_WAIT state. This is a location specific function, any action will operate on the specified location.
Boolean[] getCloseWithRstByLocation(
String location
String[] names
)getCompletionRules( names ) throws ObjectDoesNotExist
Get the rules that are run on the completion of a transaction for each of the named virtual servers.
VirtualServer.Rule[][] getCompletionRules(
String[] names
)getCompletionRulesByLocation( location, names ) throws ObjectDoesNotExist
Get the rules that are run on the completion of a transaction for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
VirtualServer.Rule[][] getCompletionRulesByLocation(
String location
String[] names
)getCompressUnknownSize( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should compress documents with no given size.
Boolean[] getCompressUnknownSize(
String[] names
)getCompressUnknownSizeByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should compress documents with no given size. This is a location specific function, any action will operate on the specified location.
Boolean[] getCompressUnknownSizeByLocation(
String location
String[] names
)getCompressionETagRewrite( names ) throws ObjectDoesNotExist
Get how the ETag header should be manipulated when compressing content.
VirtualServer.CompressionETagRewrite[] getCompressionETagRewrite(
String[] names
)getCompressionETagRewriteByLocation( location, names ) throws ObjectDoesNotExist
Get how the ETag header should be manipulated when compressing content. This is a location specific function, any action will operate on the specified location.
VirtualServer.CompressionETagRewrite[] getCompressionETagRewriteByLocation(
String location
String[] names
)getCompressionEnabled( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should compress web pages before sending to the client.
Boolean[] getCompressionEnabled(
String[] names
)getCompressionEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should compress web pages before sending to the client. This is a location specific function, any action will operate on the specified location.
Boolean[] getCompressionEnabledByLocation(
String location
String[] names
)getCompressionLevel( names ) throws ObjectDoesNotExist
Get the gzip compression level, for each of the named virtual servers.
Unsigned Integer[] getCompressionLevel(
String[] names
)getCompressionLevelByLocation( location, names ) throws ObjectDoesNotExist
Get the gzip compression level, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getCompressionLevelByLocation(
String location
String[] names
)getCompressionMIMETypes( names ) throws ObjectDoesNotExist
Get the list of MIME types to compress, for each of the named virtual servers.
String[][] getCompressionMIMETypes(
String[] names
)getCompressionMIMETypesByLocation( location, names ) throws ObjectDoesNotExist
Get the list of MIME types to compress, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
String[][] getCompressionMIMETypesByLocation(
String location
String[] names
)getCompressionMaxSize( names ) throws ObjectDoesNotExist
Get the maximum document size to compress, in bytes, for each of the named virtual servers. A document size of '0' means 'unlimited'.
Unsigned Integer[] getCompressionMaxSize(
String[] names
)getCompressionMaxSizeByLocation( location, names ) throws ObjectDoesNotExist
Get the maximum document size to compress, in bytes, for each of the named virtual servers. A document size of '0' means 'unlimited'. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getCompressionMaxSizeByLocation(
String location
String[] names
)getCompressionMinSize( names ) throws ObjectDoesNotExist
Get the minimum document size to compress, in bytes, for each of the named virtual servers.
Unsigned Integer[] getCompressionMinSize(
String[] names
)getCompressionMinSizeByLocation( location, names ) throws ObjectDoesNotExist
Get the minimum document size to compress, in bytes, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getCompressionMinSizeByLocation(
String location
String[] names
)getConnectTimeout( names ) throws ObjectDoesNotExist
Get the time, in seconds, for which an established connection can remain idle waiting for some initial data to be received from the client. The initial data is defined as a complete set of request headers for HTTP, SIP and RTSP services, or the first byte of data for all other services. A value of 0 will disable the timeout.
Unsigned Integer[] getConnectTimeout(
String[] names
)getConnectTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the time, in seconds, for which an established connection can remain idle waiting for some initial data to be received from the client. The initial data is defined as a complete set of request headers for HTTP, SIP and RTSP services, or the first byte of data for all other services. A value of 0 will disable the timeout. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getConnectTimeoutByLocation(
String location
String[] names
)getCookieDomainRewriteMode( names ) throws ObjectDoesNotExist
Get how each of the named virtual servers should rewrite the domain portion of cookies set by a back-end web server.
VirtualServer.CookieDomainRewriteMode[] getCookieDomainRewriteMode(
String[] names
)getCookieDomainRewriteModeByLocation( location, names ) throws ObjectDoesNotExist
Get how each of the named virtual servers should rewrite the domain portion of cookies set by a back-end web server. This is a location specific function, any action will operate on the specified location.
VirtualServer.CookieDomainRewriteMode[] getCookieDomainRewriteModeByLocation(
String location
String[] names
)getCookieNamedDomain( names ) throws ObjectDoesNotExist
Get the domain to use when rewriting cookie domains, for each of the named virtual servers.
String[] getCookieNamedDomain(
String[] names
)getCookieNamedDomainByLocation( location, names ) throws ObjectDoesNotExist
Get the domain to use when rewriting cookie domains, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
String[] getCookieNamedDomainByLocation(
String location
String[] names
)getCookiePathRewrite( names ) throws ObjectDoesNotExist
For each of the named virtual servers, get the regex and replacement for rewriting the path portion of a cookie.
VirtualServer.RegexReplacement[] getCookiePathRewrite(
String[] names
)getCookiePathRewriteByLocation( location, names ) throws ObjectDoesNotExist
For each of the named virtual servers, get the regex and replacement for rewriting the path portion of a cookie. This is a location specific function, any action will operate on the specified location.
VirtualServer.RegexReplacement[] getCookiePathRewriteByLocation(
String location
String[] names
)getCookieSecureFlagRewriteMode( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should modify the 'secure' tag of cookies set by a back-end web server.
VirtualServer.CookieSecureFlagRewriteMode[] getCookieSecureFlagRewriteMode(
String[] names
)getCookieSecureFlagRewriteModeByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should modify the 'secure' tag of cookies set by a back-end web server. This is a location specific function, any action will operate on the specified location.
VirtualServer.CookieSecureFlagRewriteMode[] getCookieSecureFlagRewriteModeByLocation(
String location
String[] names
)getDNSEdnsClientSubnet( names ) throws ObjectDoesNotExist
Get whether use of EDNS client subnet option is enabled
Boolean[] getDNSEdnsClientSubnet(
String[] names
)getDNSEdnsClientSubnetByLocation( location, names ) throws ObjectDoesNotExist
Get whether use of EDNS client subnet option is enabled This is a location specific function, any action will operate on the specified location.
Boolean[] getDNSEdnsClientSubnetByLocation(
String location
String[] names
)getDNSEdnsUdpsize( names ) throws ObjectDoesNotExist
Get EDNS UDP size advertised in responses
Unsigned Integer[] getDNSEdnsUdpsize(
String[] names
)getDNSEdnsUdpsizeByLocation( location, names ) throws ObjectDoesNotExist
Get EDNS UDP size advertised in responses This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getDNSEdnsUdpsizeByLocation(
String location
String[] names
)getDNSMaxUdpsize( names ) throws ObjectDoesNotExist
Get Maximum UDP answer size
Unsigned Integer[] getDNSMaxUdpsize(
String[] names
)getDNSMaxUdpsizeByLocation( location, names ) throws ObjectDoesNotExist
Get Maximum UDP answer size This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getDNSMaxUdpsizeByLocation(
String location
String[] names
)getDNSRecordsetOrder( names ) throws ObjectDoesNotExist
Get order of records in a DNS response
VirtualServer.DNSRecordsetOrder[] getDNSRecordsetOrder(
String[] names
)getDNSRecordsetOrderByLocation( location, names ) throws ObjectDoesNotExist
Get order of records in a DNS response This is a location specific function, any action will operate on the specified location.
VirtualServer.DNSRecordsetOrder[] getDNSRecordsetOrderByLocation(
String location
String[] names
)getDNSVerbose( names ) throws ObjectDoesNotExist
Get whether built-in DNS server should log verbose messges
Boolean[] getDNSVerbose(
String[] names
)getDNSVerboseByLocation( location, names ) throws ObjectDoesNotExist
Get whether built-in DNS server should log verbose messges This is a location specific function, any action will operate on the specified location.
Boolean[] getDNSVerboseByLocation(
String location
String[] names
)getDNSZones( names ) throws ObjectDoesNotExist
Get Space separated list of DNS zones
String[][] getDNSZones(
String[] names
)getDNSZonesByLocation( location, names ) throws ObjectDoesNotExist
Get Space separated list of DNS zones This is a location specific function, any action will operate on the specified location.
String[][] getDNSZonesByLocation(
String location
String[] names
)getDefaultPool( names ) throws ObjectDoesNotExist
Get the default Pool that traffic is sent to for each of the named virtual servers.
String[] getDefaultPool(
String[] names
)getDefaultPoolByLocation( location, names ) throws ObjectDoesNotExist
Get the default Pool that traffic is sent to for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
String[] getDefaultPoolByLocation(
String location
String[] names
)getEnabled( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers is enabled (i.e. serving traffic).
Boolean[] getEnabled(
String[] names
)getEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers is enabled (i.e. serving traffic). This is a location specific function, any action will operate on the specified location.
Boolean[] getEnabledByLocation(
String location
String[] names
)getErrorFile( names ) throws ObjectDoesNotExist
Get the file names of the error texts that each of the named virtual servers will send back to a client in case of back-end or internal errors.
String[] getErrorFile(
String[] names
)getErrorFileByLocation( location, names ) throws ObjectDoesNotExist
Get the file names of the error texts that each of the named virtual servers will send back to a client in case of back-end or internal errors. This is a location specific function, any action will operate on the specified location.
String[] getErrorFileByLocation(
String location
String[] names
)getFTPDataSourcePort( names ) throws ObjectDoesNotExist
Get the source port each of the named virtual servers should use for active-mode FTP data connections. If 0, a random high port will be used, otherwise the specified port will be used. If a port below 1024 is required you must first explicitly permit use of low ports with the ftp_data_bind_low global setting.
Unsigned Integer[] getFTPDataSourcePort(
String[] names
)getFTPDataSourcePortByLocation( location, names ) throws ObjectDoesNotExist
Get the source port each of the named virtual servers should use for active-mode FTP data connections. If 0, a random high port will be used, otherwise the specified port will be used. If a port below 1024 is required you must first explicitly permit use of low ports with the ftp_data_bind_low global setting. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getFTPDataSourcePortByLocation(
String location
String[] names
)getFTPForceClientSecure( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should require incoming FTP data connections (from clients) to originate from the same IP address as the corresponding control connection.
Boolean[] getFTPForceClientSecure(
String[] names
)getFTPForceClientSecureByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should require incoming FTP data connections (from clients) to originate from the same IP address as the corresponding control connection. This is a location specific function, any action will operate on the specified location.
Boolean[] getFTPForceClientSecureByLocation(
String location
String[] names
)getFTPForceServerSecure( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should require incoming FTP data connections (from nodes) to originate from the same IP address as the corresponding control connection.
Boolean[] getFTPForceServerSecure(
String[] names
)getFTPForceServerSecureByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should require incoming FTP data connections (from nodes) to originate from the same IP address as the corresponding control connection. This is a location specific function, any action will operate on the specified location.
Boolean[] getFTPForceServerSecureByLocation(
String location
String[] names
)getFTPPortRange( names ) throws ObjectDoesNotExist
Get the port range used for FTP data connections for each of the named virtual servers.
VirtualServer.FTPPortRange[] getFTPPortRange(
String[] names
)getFTPPortRangeByLocation( location, names ) throws ObjectDoesNotExist
Get the port range used for FTP data connections for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
VirtualServer.FTPPortRange[] getFTPPortRangeByLocation(
String location
String[] names
)getFTPSSLData( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should use SSL on the data connection as well as the control connection
Boolean[] getFTPSSLData(
String[] names
)getFTPSSLDataByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should use SSL on the data connection as well as the control connection This is a location specific function, any action will operate on the specified location.
Boolean[] getFTPSSLDataByLocation(
String location
String[] names
)getGLBServices( names ) throws ObjectDoesNotExist
Get GLB Services used by the virtual server
String[][] getGLBServices(
String[] names
)getGLBServicesByLocation( location, names ) throws ObjectDoesNotExist
Get GLB Services used by the virtual server This is a location specific function, any action will operate on the specified location.
String[][] getGLBServicesByLocation(
String location
String[] names
)getHTTP2ClientBufferMultiplier( names ) throws ObjectDoesNotExist
Get the amount of memory used to store data sent by the client, in multiples of max_client_buffer, for a HTTP/2 connection.
Unsigned Integer[] getHTTP2ClientBufferMultiplier(
String[] names
)getHTTP2ClientBufferMultiplierByLocation( location, names ) throws ObjectDoesNotExist
Get the amount of memory used to store data sent by the client, in multiples of max_client_buffer, for a HTTP/2 connection. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2ClientBufferMultiplierByLocation(
String location
String[] names
)getHTTP2ConnectTimeout( names ) throws ObjectDoesNotExist
Get the time to wait for a request on a new HTTP/2 connection, in seconds. If no request is received in this time, the connection will be closed. This setting overrides 'connect_timeout', and uses the value of 'connect_timeout' if set to zero.
Unsigned Integer[] getHTTP2ConnectTimeout(
String[] names
)getHTTP2ConnectTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the time to wait for a request on a new HTTP/2 connection, in seconds. If no request is received in this time, the connection will be closed. This setting overrides 'connect_timeout', and uses the value of 'connect_timeout' if set to zero. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2ConnectTimeoutByLocation(
String location
String[] names
)getHTTP2DataFrameSize( names ) throws ObjectDoesNotExist
Get the preferred HTTP/2 data frame size
Unsigned Integer[] getHTTP2DataFrameSize(
String[] names
)getHTTP2DataFrameSizeByLocation( location, names ) throws ObjectDoesNotExist
Get the preferred HTTP/2 data frame size This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2DataFrameSizeByLocation(
String location
String[] names
)getHTTP2Enabled( names ) throws ObjectDoesNotExist
Get allows the HTTP/2 protocol to be used.
Boolean[] getHTTP2Enabled(
String[] names
)getHTTP2EnabledByLocation( location, names ) throws ObjectDoesNotExist
Get allows the HTTP/2 protocol to be used. This is a location specific function, any action will operate on the specified location.
Boolean[] getHTTP2EnabledByLocation(
String location
String[] names
)getHTTP2HeaderTableSize( names ) throws ObjectDoesNotExist
Get the amount of memory allowed for header compression
Unsigned Integer[] getHTTP2HeaderTableSize(
String[] names
)getHTTP2HeaderTableSizeByLocation( location, names ) throws ObjectDoesNotExist
Get the amount of memory allowed for header compression This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2HeaderTableSizeByLocation(
String location
String[] names
)getHTTP2HeadersIndexBlacklist( names ) throws ObjectDoesNotExist
Get a list of header names that should never be compressed using indexing.
String[][] getHTTP2HeadersIndexBlacklist(
String[] names
)getHTTP2HeadersIndexBlacklistByLocation( location, names ) throws ObjectDoesNotExist
Get a list of header names that should never be compressed using indexing. This is a location specific function, any action will operate on the specified location.
String[][] getHTTP2HeadersIndexBlacklistByLocation(
String location
String[] names
)getHTTP2HeadersIndexDefault( names ) throws ObjectDoesNotExist
Get whether all HTTP/2 headers should be compressed using indexing, except those specified in the blacklist, or whether all HTTP/2 headers should not be compressed using indexing, except those specified in the whitelist.
Boolean[] getHTTP2HeadersIndexDefault(
String[] names
)getHTTP2HeadersIndexDefaultByLocation( location, names ) throws ObjectDoesNotExist
Get whether all HTTP/2 headers should be compressed using indexing, except those specified in the blacklist, or whether all HTTP/2 headers should not be compressed using indexing, except those specified in the whitelist. This is a location specific function, any action will operate on the specified location.
Boolean[] getHTTP2HeadersIndexDefaultByLocation(
String location
String[] names
)getHTTP2HeadersIndexWhitelist( names ) throws ObjectDoesNotExist
Get a list of header names that can be compressed using indexing when the default is to never index.
String[][] getHTTP2HeadersIndexWhitelist(
String[] names
)getHTTP2HeadersIndexWhitelistByLocation( location, names ) throws ObjectDoesNotExist
Get a list of header names that can be compressed using indexing when the default is to never index. This is a location specific function, any action will operate on the specified location.
String[][] getHTTP2HeadersIndexWhitelistByLocation(
String location
String[] names
)getHTTP2HeadersSizeLimit( names ) throws ObjectDoesNotExist
Get the maximum size, in bytes, of decompressed headers for an HTTP/2 request.
Unsigned Integer[] getHTTP2HeadersSizeLimit(
String[] names
)getHTTP2HeadersSizeLimitByLocation( location, names ) throws ObjectDoesNotExist
Get the maximum size, in bytes, of decompressed headers for an HTTP/2 request. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2HeadersSizeLimitByLocation(
String location
String[] names
)getHTTP2IdleTimeoutNoStreams( names ) throws ObjectDoesNotExist
Get the time to wait for an HTTP/2 request on a previously used HTTP/2 connection with no open streams.
Unsigned Integer[] getHTTP2IdleTimeoutNoStreams(
String[] names
)getHTTP2IdleTimeoutNoStreamsByLocation( location, names ) throws ObjectDoesNotExist
Get the time to wait for an HTTP/2 request on a previously used HTTP/2 connection with no open streams. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2IdleTimeoutNoStreamsByLocation(
String location
String[] names
)getHTTP2IdleTimeoutOpenStreams( names ) throws ObjectDoesNotExist
Get the time to wait for data on an HTTP/2 connection with open streams that haven't sent data recently
Unsigned Integer[] getHTTP2IdleTimeoutOpenStreams(
String[] names
)getHTTP2IdleTimeoutOpenStreamsByLocation( location, names ) throws ObjectDoesNotExist
Get the time to wait for data on an HTTP/2 connection with open streams that haven't sent data recently This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2IdleTimeoutOpenStreamsByLocation(
String location
String[] names
)getHTTP2MaxConcurrentStreams( names ) throws ObjectDoesNotExist
Get the number of concurrent streams allowed
Unsigned Integer[] getHTTP2MaxConcurrentStreams(
String[] names
)getHTTP2MaxConcurrentStreamsByLocation( location, names ) throws ObjectDoesNotExist
Get the number of concurrent streams allowed This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2MaxConcurrentStreamsByLocation(
String location
String[] names
)getHTTP2MaxFrameSize( names ) throws ObjectDoesNotExist
Get the maximum HTTP/2 frame size
Unsigned Integer[] getHTTP2MaxFrameSize(
String[] names
)getHTTP2MaxFrameSizeByLocation( location, names ) throws ObjectDoesNotExist
Get the maximum HTTP/2 frame size This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2MaxFrameSizeByLocation(
String location
String[] names
)getHTTP2MaxHeaderPadding( names ) throws ObjectDoesNotExist
Get the maximum size, in bytes, of random-length padding to add to HTTP/2 header frames
Unsigned Integer[] getHTTP2MaxHeaderPadding(
String[] names
)getHTTP2MaxHeaderPaddingByLocation( location, names ) throws ObjectDoesNotExist
Get the maximum size, in bytes, of random-length padding to add to HTTP/2 header frames This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2MaxHeaderPaddingByLocation(
String location
String[] names
)getHTTP2MergeCookieHeaders( names ) throws ObjectDoesNotExist
Get whether Cookie headers received from an HTTP/2 client should be merged into a single Cookie header before forwarding to an HTTP/1.1 server.
Boolean[] getHTTP2MergeCookieHeaders(
String[] names
)getHTTP2MergeCookieHeadersByLocation( location, names ) throws ObjectDoesNotExist
Get whether Cookie headers received from an HTTP/2 client should be merged into a single Cookie header before forwarding to an HTTP/1.1 server. This is a location specific function, any action will operate on the specified location.
Boolean[] getHTTP2MergeCookieHeadersByLocation(
String location
String[] names
)getHTTP2ServerBufferMultiplier( names ) throws ObjectDoesNotExist
Get the amount of memory used to store data sent by the server, in multiples of max_server_buffer, for a HTTP/2 connection.
Unsigned Integer[] getHTTP2ServerBufferMultiplier(
String[] names
)getHTTP2ServerBufferMultiplierByLocation( location, names ) throws ObjectDoesNotExist
Get the amount of memory used to store data sent by the server, in multiples of max_server_buffer, for a HTTP/2 connection. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2ServerBufferMultiplierByLocation(
String location
String[] names
)getHTTP2StreamWindowSize( names ) throws ObjectDoesNotExist
Get the flow control window size
Unsigned Integer[] getHTTP2StreamWindowSize(
String[] names
)getHTTP2StreamWindowSizeByLocation( location, names ) throws ObjectDoesNotExist
Get the flow control window size This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getHTTP2StreamWindowSizeByLocation(
String location
String[] names
)getHttpChunkOverheadForwarding( names ) throws ObjectDoesNotExist
Get how to handle forwarding of data that is pure HTTP chunking overhead.
VirtualServer.HttpChunkOverheadForwarding[] getHttpChunkOverheadForwarding(
String[] names
)getHttpChunkOverheadForwardingByLocation( location, names ) throws ObjectDoesNotExist
Get how to handle forwarding of data that is pure HTTP chunking overhead. This is a location specific function, any action will operate on the specified location.
VirtualServer.HttpChunkOverheadForwarding[] getHttpChunkOverheadForwardingByLocation(
String location
String[] names
)getKeepalive( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should allow clients to maintain keepalive connections.
Boolean[] getKeepalive(
String[] names
)getKeepaliveByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should allow clients to maintain keepalive connections. This is a location specific function, any action will operate on the specified location.
Boolean[] getKeepaliveByLocation(
String location
String[] names
)getKeepaliveTimeout( names ) throws ObjectDoesNotExist
Get the time that an idle keepalive connection should be kept open for, in seconds, for each of the named virtual servers.
Unsigned Integer[] getKeepaliveTimeout(
String[] names
)getKeepaliveTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the time that an idle keepalive connection should be kept open for, in seconds, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getKeepaliveTimeoutByLocation(
String location
String[] names
)getKerberosProtocolTransitionEnabled( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should use Kerberos Protocol Transition.
Boolean[] getKerberosProtocolTransitionEnabled(
String[] names
)getKerberosProtocolTransitionEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should use Kerberos Protocol Transition. This is a location specific function, any action will operate on the specified location.
Boolean[] getKerberosProtocolTransitionEnabledByLocation(
String location
String[] names
)getKerberosProtocolTransitionPrincipal( names ) throws ObjectDoesNotExist
Get the Kerberos principal that each of the named virtual servers uses to perform Kerberos Protocol Transition
String[] getKerberosProtocolTransitionPrincipal(
String[] names
)getKerberosProtocolTransitionPrincipalByLocation( location, names ) throws ObjectDoesNotExist
Get the Kerberos principal that each of the named virtual servers uses to perform Kerberos Protocol Transition This is a location specific function, any action will operate on the specified location.
String[] getKerberosProtocolTransitionPrincipalByLocation(
String location
String[] names
)getKerberosProtocolTransitionTarget( names ) throws ObjectDoesNotExist
Get the Kerberos principal name of the service that each of the named virtual servers targets
String[] getKerberosProtocolTransitionTarget(
String[] names
)getKerberosProtocolTransitionTargetByLocation( location, names ) throws ObjectDoesNotExist
Get the Kerberos principal name of the service that each of the named virtual servers targets This is a location specific function, any action will operate on the specified location.
String[] getKerberosProtocolTransitionTargetByLocation(
String location
String[] names
)getL4AccelRSTOnServiceFailure( names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getL4AccelRSTOnServiceFailure(
String[] names
)getL4AccelRSTOnServiceFailureByLocation( location, names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getL4AccelRSTOnServiceFailureByLocation(
String location
String[] names
)getL4AccelServiceIPSNAT( names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getL4AccelServiceIPSNAT(
String[] names
)getL4AccelServiceIPSNATByLocation( location, names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getL4AccelServiceIPSNATByLocation(
String location
String[] names
)getL4AccelStateSync( names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getL4AccelStateSync(
String[] names
)getL4AccelStateSyncByLocation( location, names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getL4AccelStateSyncByLocation(
String location
String[] names
)getL4AccelTCPMaxSegmentLifetime( names ) throws ObjectDoesNotExist
This method is now obsolete.
Unsigned Integer[] getL4AccelTCPMaxSegmentLifetime(
String[] names
)getL4AccelTCPMaxSegmentLifetimeByLocation( location, names ) throws ObjectDoesNotExist
This method is now obsolete.
Unsigned Integer[] getL4AccelTCPMaxSegmentLifetimeByLocation(
String location
String[] names
)getL4AccelTimeout( names ) throws ObjectDoesNotExist
This method is now obsolete.
Unsigned Integer[] getL4AccelTimeout(
String[] names
)getL4AccelTimeoutByLocation( location, names ) throws ObjectDoesNotExist
This method is now obsolete.
Unsigned Integer[] getL4AccelTimeoutByLocation(
String location
String[] names
)getL4AccelUDPCountRequests( names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getL4AccelUDPCountRequests(
String[] names
)getL4AccelUDPCountRequestsByLocation( location, names ) throws ObjectDoesNotExist
This method is now obsolete.
Boolean[] getL4AccelUDPCountRequestsByLocation(
String location
String[] names
)getListenAddresses( names ) throws ObjectDoesNotExist
Get the specific IP addresses and hostnames that each of the named virtual servers are listening on. This will return an empty array for a virtual server if it is listening on all addresses.
String[][] getListenAddresses(
String[] names
)getListenAddressesByLocation( location, names ) throws ObjectDoesNotExist
Get the specific IP addresses and hostnames that each of the named virtual servers are listening on. This will return an empty array for a virtual server if it is listening on all addresses. This is a location specific function, any action will operate on the specified location.
String[][] getListenAddressesByLocation(
String location
String[] names
)getListenOnAllAddresses( names ) throws ObjectDoesNotExist
For each of the named virtual servers, gets whether the virtual server is listening on all IP addresses
Boolean[] getListenOnAllAddresses(
String[] names
)getListenOnAllAddressesByLocation( location, names ) throws ObjectDoesNotExist
For each of the named virtual servers, gets whether the virtual server is listening on all IP addresses This is a location specific function, any action will operate on the specified location.
Boolean[] getListenOnAllAddressesByLocation(
String location
String[] names
)getListenTrafficIPGroups( names ) throws ObjectDoesNotExist
Get the specific Traffic IP Groups that each named virtual server listens on. This will return an empty array for a virtual server if it is listening on all addresses.
String[][] getListenTrafficIPGroups(
String[] names
)getListenTrafficIPGroupsByLocation( location, names ) throws ObjectDoesNotExist
Get the specific Traffic IP Groups that each named virtual server listens on. This will return an empty array for a virtual server if it is listening on all addresses. This is a location specific function, any action will operate on the specified location.
String[][] getListenTrafficIPGroupsByLocation(
String location
String[] names
)getLocationDefaultRewriteMode( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should rewrite the 'Location' header. The rewrite is only performed if the location rewrite regex didn't match.
VirtualServer.LocationDefaultRewriteMode[] getLocationDefaultRewriteMode(
String[] names
)getLocationDefaultRewriteModeByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should rewrite the 'Location' header. The rewrite is only performed if the location rewrite regex didn't match. This is a location specific function, any action will operate on the specified location.
VirtualServer.LocationDefaultRewriteMode[] getLocationDefaultRewriteModeByLocation(
String location
String[] names
)getLocationRewrite( names ) throws ObjectDoesNotExist
For each of the named virtual servers, get the regex, and replacement for rewriting any 'Location' headers.
VirtualServer.RegexReplacement[] getLocationRewrite(
String[] names
)getLocationRewriteByLocation( location, names ) throws ObjectDoesNotExist
For each of the named virtual servers, get the regex, and replacement for rewriting any 'Location' headers. This is a location specific function, any action will operate on the specified location.
VirtualServer.RegexReplacement[] getLocationRewriteByLocation(
String location
String[] names
)getLogClientConnectionFailures( names ) throws ObjectDoesNotExist
Get whether the virtual server will log client connection failures.
Boolean[] getLogClientConnectionFailures(
String[] names
)getLogClientConnectionFailuresByLocation( location, names ) throws ObjectDoesNotExist
Get whether the virtual server will log client connection failures. This is a location specific function, any action will operate on the specified location.
Boolean[] getLogClientConnectionFailuresByLocation(
String location
String[] names
)getLogEnabled( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should log each connection to a disk on the file system.
Boolean[] getLogEnabled(
String[] names
)getLogEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should log each connection to a disk on the file system. This is a location specific function, any action will operate on the specified location.
Boolean[] getLogEnabledByLocation(
String location
String[] names
)getLogFilename( names ) throws ObjectDoesNotExist
Get the name of the file used to store request logs, for each of the named virtual servers.
String[] getLogFilename(
String[] names
)getLogFilenameByLocation( location, names ) throws ObjectDoesNotExist
Get the name of the file used to store request logs, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
String[] getLogFilenameByLocation(
String location
String[] names
)getLogFormat( names ) throws ObjectDoesNotExist
Get the log file format for each of the named virtual servers.
String[] getLogFormat(
String[] names
)getLogFormatByLocation( location, names ) throws ObjectDoesNotExist
Get the log file format for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
String[] getLogFormatByLocation(
String location
String[] names
)getLogSSLFailures( names ) throws ObjectDoesNotExist
Get whether the virtual server will log ssl failures.
Boolean[] getLogSSLFailures(
String[] names
)getLogSSLFailuresByLocation( location, names ) throws ObjectDoesNotExist
Get whether the virtual server will log ssl failures. This is a location specific function, any action will operate on the specified location.
Boolean[] getLogSSLFailuresByLocation(
String location
String[] names
)getLogSSLResumptionFailures( names ) throws ObjectDoesNotExist
Get whether the virtual server will log messages when attempts to resume SSL sessions fail.
Boolean[] getLogSSLResumptionFailures(
String[] names
)getLogSSLResumptionFailuresByLocation( location, names ) throws ObjectDoesNotExist
Get whether the virtual server will log messages when attempts to resume SSL sessions fail. This is a location specific function, any action will operate on the specified location.
Boolean[] getLogSSLResumptionFailuresByLocation(
String location
String[] names
)getLogSaveAll( names ) throws ObjectDoesNotExist
Get whether to log all connections by default, or log no connections by default.
Boolean[] getLogSaveAll(
String[] names
)getLogSaveAllByLocation( location, names ) throws ObjectDoesNotExist
Get whether to log all connections by default, or log no connections by default. This is a location specific function, any action will operate on the specified location.
Boolean[] getLogSaveAllByLocation(
String location
String[] names
)getLogServerConnectionFailures( names ) throws ObjectDoesNotExist
Get whether the virtual server will log server connection failures.
Boolean[] getLogServerConnectionFailures(
String[] names
)getLogServerConnectionFailuresByLocation( location, names ) throws ObjectDoesNotExist
Get whether the virtual server will log server connection failures. This is a location specific function, any action will operate on the specified location.
Boolean[] getLogServerConnectionFailuresByLocation(
String location
String[] names
)getLogSessionPersistenceVerbose( names ) throws ObjectDoesNotExist
Get whether the virtual server will log session persistence events.
Boolean[] getLogSessionPersistenceVerbose(
String[] names
)getLogSessionPersistenceVerboseByLocation( location, names ) throws ObjectDoesNotExist
Get whether the virtual server will log session persistence events. This is a location specific function, any action will operate on the specified location.
Boolean[] getLogSessionPersistenceVerboseByLocation(
String location
String[] names
)getMIMEAutoDetect( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should auto-detect MIME types if the server does not provide them.
Boolean[] getMIMEAutoDetect(
String[] names
)getMIMEAutoDetectByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should auto-detect MIME types if the server does not provide them. This is a location specific function, any action will operate on the specified location.
Boolean[] getMIMEAutoDetectByLocation(
String location
String[] names
)getMIMEDefaultType( names ) throws ObjectDoesNotExist
Get the MIME type that the server uses as its 'default', for each of the named virtual servers. Responses with this mime type will be auto-corrected by the virtual server if this setting is enabled.
String[] getMIMEDefaultType(
String[] names
)getMIMEDefaultTypeByLocation( location, names ) throws ObjectDoesNotExist
Get the MIME type that the server uses as its 'default', for each of the named virtual servers. Responses with this mime type will be auto-corrected by the virtual server if this setting is enabled. This is a location specific function, any action will operate on the specified location.
String[] getMIMEDefaultTypeByLocation(
String location
String[] names
)getMaxClientBuffer( names ) throws ObjectDoesNotExist
Get the amount of memory used to store data sent by the client, in bytes, for each of the named virtual servers.
Unsigned Integer[] getMaxClientBuffer(
String[] names
)getMaxClientBufferByLocation( location, names ) throws ObjectDoesNotExist
Get the amount of memory used to store data sent by the client, in bytes, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxClientBufferByLocation(
String location
String[] names
)getMaxConcurrentConnections( names ) throws ObjectDoesNotExist
Get sets the maximum number of concurrent TCP connections this virtual server will accept. A value of 0 will allow unlimited concurrent TCP connections to this virtual server.
Unsigned Integer[] getMaxConcurrentConnections(
String[] names
)getMaxConcurrentConnectionsByLocation( location, names ) throws ObjectDoesNotExist
Get sets the maximum number of concurrent TCP connections this virtual server will accept. A value of 0 will allow unlimited concurrent TCP connections to this virtual server. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxConcurrentConnectionsByLocation(
String location
String[] names
)getMaxServerBuffer( names ) throws ObjectDoesNotExist
Get the amount of memory used to store data returned by the server, in bytes, for each of the named virtual servers.
Unsigned Integer[] getMaxServerBuffer(
String[] names
)getMaxServerBufferByLocation( location, names ) throws ObjectDoesNotExist
Get the amount of memory used to store data returned by the server, in bytes, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxServerBufferByLocation(
String location
String[] names
)getMaxTransactionDuration( names ) throws ObjectDoesNotExist
Get the total amount of time a transaction can take, zero means forever.
Unsigned Integer[] getMaxTransactionDuration(
String[] names
)getMaxTransactionDurationByLocation( location, names ) throws ObjectDoesNotExist
Get the total amount of time a transaction can take, zero means forever. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getMaxTransactionDurationByLocation(
String location
String[] names
)getNote( names ) throws ObjectDoesNotExist
Get the note for each of the named virtual servers.
String[] getNote(
String[] names
)getPort( names ) throws ObjectDoesNotExist
Get the port that each of the named virtual servers listens on for incoming connections.
Unsigned Integer[] getPort(
String[] names
)getPortByLocation( location, names ) throws ObjectDoesNotExist
Get the port that each of the named virtual servers listens on for incoming connections. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getPortByLocation(
String location
String[] names
)getProtection( names ) throws ObjectDoesNotExist
Get the Service Protection Settings that are used to protect each of the named virtual servers.
String[] getProtection(
String[] names
)getProtectionByLocation( location, names ) throws ObjectDoesNotExist
Get the Service Protection Settings that are used to protect each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
String[] getProtectionByLocation(
String location
String[] names
)getProtocol( names ) throws ObjectDoesNotExist
Get the protocol that each of the named virtual servers uses.
VirtualServer.Protocol[] getProtocol(
String[] names
)getProxyClose( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should send a FIN packet on to the back-end server when it is received from the client. The alternative is to close the connection to the client immediately. If the traffic manager is responding to the request itself, enabling this setting will cause the traffic manager to continue writing the response even after it has received a FIN from the client.
Boolean[] getProxyClose(
String[] names
)getProxyCloseByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should send a FIN packet on to the back-end server when it is received from the client. The alternative is to close the connection to the client immediately. If the traffic manager is responding to the request itself, enabling this setting will cause the traffic manager to continue writing the response even after it has received a FIN from the client. This is a location specific function, any action will operate on the specified location.
Boolean[] getProxyCloseByLocation(
String location
String[] names
)getProxyProtocol( names ) throws ObjectDoesNotExist
Get expect connections to the traffic manager to be prefixed with a PROXY protocol header.
Boolean[] getProxyProtocol(
String[] names
)getProxyProtocolByLocation( location, names ) throws ObjectDoesNotExist
Get expect connections to the traffic manager to be prefixed with a PROXY protocol header. This is a location specific function, any action will operate on the specified location.
Boolean[] getProxyProtocolByLocation(
String location
String[] names
)getRTSPPortRange( names ) throws ObjectDoesNotExist
Get the port range used for RTSP streaming data connections, for each of the named virtual servers.
VirtualServer.PortRange[] getRTSPPortRange(
String[] names
)getRTSPPortRangeByLocation( location, names ) throws ObjectDoesNotExist
Get the port range used for RTSP streaming data connections, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
VirtualServer.PortRange[] getRTSPPortRangeByLocation(
String location
String[] names
)getRTSPStreamingTimeout( names ) throws ObjectDoesNotExist
Get the time, in seconds, after which data-streams associated with RTSP connections timeout if no data is transmitted.
Unsigned Integer[] getRTSPStreamingTimeout(
String[] names
)getRTSPStreamingTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the time, in seconds, after which data-streams associated with RTSP connections timeout if no data is transmitted. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getRTSPStreamingTimeoutByLocation(
String location
String[] names
)getRecentConnsEnabled( names ) throws ObjectDoesNotExist
Get whether or not any connections handled by this virtual server should be shown on the Connections page.
Boolean[] getRecentConnsEnabled(
String[] names
)getRecentConnsEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether or not any connections handled by this virtual server should be shown on the Connections page. This is a location specific function, any action will operate on the specified location.
Boolean[] getRecentConnsEnabledByLocation(
String location
String[] names
)getRecentConnsSaveAll( names ) throws ObjectDoesNotExist
Get whether or not all connections handled by this virtual server should be shown on the Connections page.
Boolean[] getRecentConnsSaveAll(
String[] names
)getRecentConnsSaveAllByLocation( location, names ) throws ObjectDoesNotExist
Get whether or not all connections handled by this virtual server should be shown on the Connections page. This is a location specific function, any action will operate on the specified location.
Boolean[] getRecentConnsSaveAllByLocation(
String location
String[] names
)getRequestSyslogEnabled( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should log each connection to a remote syslog server.
Boolean[] getRequestSyslogEnabled(
String[] names
)getRequestSyslogEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should log each connection to a remote syslog server. This is a location specific function, any action will operate on the specified location.
Boolean[] getRequestSyslogEnabledByLocation(
String location
String[] names
)getRequestSyslogFormat( names ) throws ObjectDoesNotExist
Get the remote log line format for each of the named virtual servers.
String[] getRequestSyslogFormat(
String[] names
)getRequestSyslogFormatByLocation( location, names ) throws ObjectDoesNotExist
Get the remote log line format for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
String[] getRequestSyslogFormatByLocation(
String location
String[] names
)getRequestSyslogIPEndpoint( names ) throws ObjectDoesNotExist
Get the remote syslog endpoint for each of the named virtual servers
String[] getRequestSyslogIPEndpoint(
String[] names
)getRequestSyslogIPEndpointByLocation( location, names ) throws ObjectDoesNotExist
Get the remote syslog endpoint for each of the named virtual servers This is a location specific function, any action will operate on the specified location.
String[] getRequestSyslogIPEndpointByLocation(
String location
String[] names
)getRequestSyslogMessageLenLimit( names ) throws ObjectDoesNotExist
Get syslog message length limit.
Unsigned Integer[] getRequestSyslogMessageLenLimit(
String[] names
)getRequestSyslogMessageLenLimitByLocation( location, names ) throws ObjectDoesNotExist
Get syslog message length limit. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getRequestSyslogMessageLenLimitByLocation(
String location
String[] names
)getRequestTracingEnabled( names ) throws ObjectDoesNotExist
Get whether to record a detailed list of processing history for each request.
Boolean[] getRequestTracingEnabled(
String[] names
)getRequestTracingEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether to record a detailed list of processing history for each request. This is a location specific function, any action will operate on the specified location.
Boolean[] getRequestTracingEnabledByLocation(
String location
String[] names
)getRequestTracingIO( names ) throws ObjectDoesNotExist
Get whether to record a detailed list of every IO event in the processing history for each request.
Boolean[] getRequestTracingIO(
String[] names
)getRequestTracingIOByLocation( location, names ) throws ObjectDoesNotExist
Get whether to record a detailed list of every IO event in the processing history for each request. This is a location specific function, any action will operate on the specified location.
Boolean[] getRequestTracingIOByLocation(
String location
String[] names
)getResponseRules( names ) throws ObjectDoesNotExist
Get the rules that are run on server responses for each of the named virtual servers.
VirtualServer.Rule[][] getResponseRules(
String[] names
)getResponseRulesByLocation( location, names ) throws ObjectDoesNotExist
Get the rules that are run on server responses for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
VirtualServer.Rule[][] getResponseRulesByLocation(
String location
String[] names
)getRewriteSIPURI( names ) throws ObjectDoesNotExist
Get whether the Request-URI of SIP requests will be replaced with the selected back-end node's address.
Boolean[] getRewriteSIPURI(
String[] names
)getRewriteSIPURIByLocation( location, names ) throws ObjectDoesNotExist
Get whether the Request-URI of SIP requests will be replaced with the selected back-end node's address. This is a location specific function, any action will operate on the specified location.
Boolean[] getRewriteSIPURIByLocation(
String location
String[] names
)getRules( names ) throws ObjectDoesNotExist
Get the rules that are run on client requests for each of the named virtual servers.
VirtualServer.Rule[][] getRules(
String[] names
)getRulesByLocation( location, names ) throws ObjectDoesNotExist
Get the rules that are run on client requests for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
VirtualServer.Rule[][] getRulesByLocation(
String location
String[] names
)getSIPDangerousRequestMode( names ) throws ObjectDoesNotExist
Get what should be done with requests that contain body data and should be routed to an external IP.
VirtualServer.SIPDangerousRequestMode[] getSIPDangerousRequestMode(
String[] names
)getSIPDangerousRequestModeByLocation( location, names ) throws ObjectDoesNotExist
Get what should be done with requests that contain body data and should be routed to an external IP. This is a location specific function, any action will operate on the specified location.
VirtualServer.SIPDangerousRequestMode[] getSIPDangerousRequestModeByLocation(
String location
String[] names
)getSIPFollowRoute( names ) throws ObjectDoesNotExist
Get whether to follow routing information in SIP requests.
Boolean[] getSIPFollowRoute(
String[] names
)getSIPFollowRouteByLocation( location, names ) throws ObjectDoesNotExist
Get whether to follow routing information in SIP requests. This is a location specific function, any action will operate on the specified location.
Boolean[] getSIPFollowRouteByLocation(
String location
String[] names
)getSIPMaxConnectionMemory( names ) throws ObjectDoesNotExist
Get maximum memory per connection.
Unsigned Integer[] getSIPMaxConnectionMemory(
String[] names
)getSIPMaxConnectionMemoryByLocation( location, names ) throws ObjectDoesNotExist
Get maximum memory per connection. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getSIPMaxConnectionMemoryByLocation(
String location
String[] names
)getSIPMode( names ) throws ObjectDoesNotExist
Get which mode of operation the SIP virtual server should run in.
VirtualServer.SIPMode[] getSIPMode(
String[] names
)getSIPModeByLocation( location, names ) throws ObjectDoesNotExist
Get which mode of operation the SIP virtual server should run in. This is a location specific function, any action will operate on the specified location.
VirtualServer.SIPMode[] getSIPModeByLocation(
String location
String[] names
)getSIPPortRange( names ) throws ObjectDoesNotExist
Get the port range used for SIP data connections, for each of the named virtual servers. This setting is only used when the SIP virtual server is using 'Full Gateway' mode.
VirtualServer.PortRange[] getSIPPortRange(
String[] names
)getSIPPortRangeByLocation( location, names ) throws ObjectDoesNotExist
Get the port range used for SIP data connections, for each of the named virtual servers. This setting is only used when the SIP virtual server is using 'Full Gateway' mode. This is a location specific function, any action will operate on the specified location.
VirtualServer.PortRange[] getSIPPortRangeByLocation(
String location
String[] names
)getSIPStreamingTimeout( names ) throws ObjectDoesNotExist
Get the time, in seconds, after which a UDP stream will timeout if it has not seen any data.
Unsigned Integer[] getSIPStreamingTimeout(
String[] names
)getSIPStreamingTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the time, in seconds, after which a UDP stream will timeout if it has not seen any data. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getSIPStreamingTimeoutByLocation(
String location
String[] names
)getSIPTimeoutMessages( names ) throws ObjectDoesNotExist
Get send a timed out response to the client and CANCEL request to the server when a transaction times out.
Boolean[] getSIPTimeoutMessages(
String[] names
)getSIPTimeoutMessagesByLocation( location, names ) throws ObjectDoesNotExist
Get send a timed out response to the client and CANCEL request to the server when a transaction times out. This is a location specific function, any action will operate on the specified location.
Boolean[] getSIPTimeoutMessagesByLocation(
String location
String[] names
)getSIPUDPAssociateBySource( names ) throws ObjectDoesNotExist
Get whether all datagrams in a SIP transaction must have been received from the same source address and port.
Boolean[] getSIPUDPAssociateBySource(
String[] names
)getSIPUDPAssociateBySourceByLocation( location, names ) throws ObjectDoesNotExist
Get whether all datagrams in a SIP transaction must have been received from the same source address and port. This is a location specific function, any action will operate on the specified location.
Boolean[] getSIPUDPAssociateBySourceByLocation(
String location
String[] names
)getSSLCertificate( names ) throws ObjectDoesNotExist
Get the name of the default SSL Certificate that is used for SSL decryption for each of the named virtual servers. This is the name of an item in the SSL Certificates Catalog.
String[] getSSLCertificate(
String[] names
)getSSLCertificateByLocation( location, names ) throws ObjectDoesNotExist
Get the name of the default SSL Certificate that is used for SSL decryption for each of the named virtual servers. This is the name of an item in the SSL Certificates Catalog. This is a location specific function, any action will operate on the specified location.
String[] getSSLCertificateByLocation(
String location
String[] names
)getSSLCertificates( names ) throws ObjectDoesNotExist
Get the name of the default SSL Certificate, as well as alt certificates, that can be used for SSL decryption for each of the named virtual servers. This is the name of an item in the SSL Certificates Catalog.
String[][] getSSLCertificates(
String[] names
)getSSLCertificatesByLocation( location, names ) throws ObjectDoesNotExist
Get the name of the default SSL Certificate, as well as alt certificates, that can be used for SSL decryption for each of the named virtual servers. This is the name of an item in the SSL Certificates Catalog. This is a location specific function, any action will operate on the specified location.
String[][] getSSLCertificatesByLocation(
String location
String[] names
)getSSLCipherSuites( names ) throws ObjectDoesNotExist
Get the SSL/TLS cipher suites allowed for connections to this virtual server
String[] getSSLCipherSuites(
String[] names
)getSSLCipherSuitesByLocation( location, names ) throws ObjectDoesNotExist
Get the SSL/TLS cipher suites allowed for connections to this virtual server This is a location specific function, any action will operate on the specified location.
String[] getSSLCipherSuitesByLocation(
String location
String[] names
)getSSLCiphers( names ) throws ObjectDoesNotExist
This method is deprecated, and has been replaced with VirtualServer.getSSLCipherSuites.
String[] getSSLCiphers(
String[] names
)getSSLCiphersByLocation( location, names ) throws ObjectDoesNotExist
This method is deprecated, and has been replaced with VirtualServer.getSSLCipherSuites. This is a location specific function, any action will operate on the specified location.
String[] getSSLCiphersByLocation(
String location
String[] names
)getSSLClientCertificateAuthorities( names ) throws ObjectDoesNotExist
Get the certificate authorities that are trusted for validating client certificates, for each of the named virtual servers.
String[][] getSSLClientCertificateAuthorities(
String[] names
)getSSLClientCertificateAuthoritiesByLocation( location, names ) throws ObjectDoesNotExist
Get the certificate authorities that are trusted for validating client certificates, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
String[][] getSSLClientCertificateAuthoritiesByLocation(
String location
String[] names
)getSSLClientCertificateHeaders( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should add HTTP headers to each request to show the data in the client certificate.
VirtualServer.SSLClientCertificateHeaders[] getSSLClientCertificateHeaders(
String[] names
)getSSLClientCertificateHeadersByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should add HTTP headers to each request to show the data in the client certificate. This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLClientCertificateHeaders[] getSSLClientCertificateHeadersByLocation(
String location
String[] names
)getSSLDecrypt( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should decrypt SSL traffic.
Boolean[] getSSLDecrypt(
String[] names
)getSSLDecryptByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should decrypt SSL traffic. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLDecryptByLocation(
String location
String[] names
)getSSLEllipticCurves( names ) throws ObjectDoesNotExist
Get the elliptic curve preference list for SSL connections to this virtual server
String[] getSSLEllipticCurves(
String[] names
)getSSLEllipticCurvesByLocation( location, names ) throws ObjectDoesNotExist
Get the elliptic curve preference list for SSL connections to this virtual server This is a location specific function, any action will operate on the specified location.
String[] getSSLEllipticCurvesByLocation(
String location
String[] names
)getSSLExpectStartTLS( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should upgrade SMTP connections to SSL using the STARTTLS command.
Boolean[] getSSLExpectStartTLS(
String[] names
)getSSLExpectStartTLSByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should upgrade SMTP connections to SSL using the STARTTLS command. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLExpectStartTLSByLocation(
String location
String[] names
)getSSLHeaders( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should add HTTP headers to each request to show SSL connection parameters.
Boolean[] getSSLHeaders(
String[] names
)getSSLHeadersByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should add HTTP headers to each request to show SSL connection parameters. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLHeadersByLocation(
String location
String[] names
)getSSLHonorFallbackSCSV( names ) throws ObjectDoesNotExist
Get whether Fallback SCSV is honored by this virtual server
VirtualServer.SSLHonorFallbackSCSV[] getSSLHonorFallbackSCSV(
String[] names
)getSSLHonorFallbackSCSVByLocation( location, names ) throws ObjectDoesNotExist
Get whether Fallback SCSV is honored by this virtual server This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLHonorFallbackSCSV[] getSSLHonorFallbackSCSVByLocation(
String location
String[] names
)getSSLLogEnabled( names ) throws ObjectDoesNotExist
This method is now obsolete. SSL logging is now done if LogConnectionFailures is enabled. Use VirtualServer.getLogConnectionFailures and VirtualServer.getLogConnection failures to control this configuration.
Boolean[] getSSLLogEnabled(
String[] names
)getSSLNeverExpiringClientCertificateAuthorities( names ) throws ObjectDoesNotExist
Get the CAs for which any client certificate they validate is considered valid even if the client certificate's expiration date has passed.
String[][] getSSLNeverExpiringClientCertificateAuthorities(
String[] names
)getSSLNeverExpiringClientCertificateAuthoritiesByLocation( location, names ) throws ObjectDoesNotExist
Get the CAs for which any client certificate they validate is considered valid even if the client certificate's expiration date has passed. This is a location specific function, any action will operate on the specified location.
String[][] getSSLNeverExpiringClientCertificateAuthoritiesByLocation(
String location
String[] names
)getSSLNeverExpiringClientCertificateAuthoritiesDepth( names ) throws ObjectDoesNotExist
Get the number of certificates in a certificate chain beyond those listed as NeverExpiringClientCertificateAuthorities whose certificate expiry will not be checked.
Unsigned Integer[] getSSLNeverExpiringClientCertificateAuthoritiesDepth(
String[] names
)getSSLNeverExpiringClientCertificateAuthoritiesDepthByLocation( location, names ) throws ObjectDoesNotExist
Get the number of certificates in a certificate chain beyond those listed as NeverExpiringClientCertificateAuthorities whose certificate expiry will not be checked. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getSSLNeverExpiringClientCertificateAuthoritiesDepthByLocation(
String location
String[] names
)getSSLOCSPDefaults( names ) throws ObjectDoesNotExist
Get the default OCSP responder settings for all client certificates.
VirtualServer.SSLOCSPIssuer[] getSSLOCSPDefaults(
String[] names
)getSSLOCSPDefaultsByLocation( location, names ) throws ObjectDoesNotExist
Get the default OCSP responder settings for all client certificates. This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLOCSPIssuer[] getSSLOCSPDefaultsByLocation(
String location
String[] names
)getSSLOCSPIssuers( names ) throws ObjectDoesNotExist
Gets a list of mappings between Certificate Authorities and OCSP responder settings. Certificates issued by these authorities will be verified with OCSP using these settings.
VirtualServer.SSLOCSPIssuer[][] getSSLOCSPIssuers(
String[] names
)getSSLOCSPIssuersByLocation( location, names ) throws ObjectDoesNotExist
Gets a list of mappings between Certificate Authorities and OCSP responder settings. Certificates issued by these authorities will be verified with OCSP using these settings. This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLOCSPIssuer[][] getSSLOCSPIssuersByLocation(
String location
String[] names
)getSSLOCSPMaxResponseAge( names ) throws ObjectDoesNotExist
Get the number of seconds for which an OCSP response is considered valid if it has not yet exceeded the time specified in the 'nextUpdate' field
Unsigned Integer[] getSSLOCSPMaxResponseAge(
String[] names
)getSSLOCSPMaxResponseAgeByLocation( location, names ) throws ObjectDoesNotExist
Get the number of seconds for which an OCSP response is considered valid if it has not yet exceeded the time specified in the 'nextUpdate' field This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getSSLOCSPMaxResponseAgeByLocation(
String location
String[] names
)getSSLOCSPStapling( names ) throws ObjectDoesNotExist
Get whether the traffic manager is allowed to provide OCSP responses for certificates as part of the handshake, if the client sends a TLS status_request extension in the ClientHello, and OCSP URIs are present in certificates used by this virtual server.
Boolean[] getSSLOCSPStapling(
String[] names
)getSSLOCSPStaplingByLocation( location, names ) throws ObjectDoesNotExist
Get whether the traffic manager is allowed to provide OCSP responses for certificates as part of the handshake, if the client sends a TLS status_request extension in the ClientHello, and OCSP URIs are present in certificates used by this virtual server. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLOCSPStaplingByLocation(
String location
String[] names
)getSSLOCSPTimeTolerance( names ) throws ObjectDoesNotExist
Get the number of seconds outside the permitted range for which the 'thisUpdate' and 'nextUpdate' fields of an OCSP response are still considered valid
Unsigned Integer[] getSSLOCSPTimeTolerance(
String[] names
)getSSLOCSPTimeToleranceByLocation( location, names ) throws ObjectDoesNotExist
Get the number of seconds outside the permitted range for which the 'thisUpdate' and 'nextUpdate' fields of an OCSP response are still considered valid This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getSSLOCSPTimeToleranceByLocation(
String location
String[] names
)getSSLOCSPTimeout( names ) throws ObjectDoesNotExist
Get the number of seconds after which OCSP requests will be timed out
Unsigned Integer[] getSSLOCSPTimeout(
String[] names
)getSSLOCSPTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the number of seconds after which OCSP requests will be timed out This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getSSLOCSPTimeoutByLocation(
String location
String[] names
)getSSLPreferSSLv3( names ) throws ObjectDoesNotExist
This method is now deprecated.
Boolean[] getSSLPreferSSLv3(
String[] names
)getSSLPreferSSLv3ByLocation( location, names ) throws ObjectDoesNotExist
This method is now deprecated. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLPreferSSLv3ByLocation(
String location
String[] names
)getSSLRequestClientCertMode( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should request (or require) an identifying certificate from each client.
VirtualServer.SSLRequestClientCertMode[] getSSLRequestClientCertMode(
String[] names
)getSSLRequestClientCertModeByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should request (or require) an identifying certificate from each client. This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLRequestClientCertMode[] getSSLRequestClientCertModeByLocation(
String location
String[] names
)getSSLSendCloseAlerts( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should send a close alert when initiating SSL socket disconnections.
Boolean[] getSSLSendCloseAlerts(
String[] names
)getSSLSendCloseAlertsByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should send a close alert when initiating SSL socket disconnections. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLSendCloseAlertsByLocation(
String location
String[] names
)getSSLSessionCacheEnabled( names ) throws ObjectDoesNotExist
Get whether use of the session cache is enabled for this virtual server
VirtualServer.SSLSessionCacheEnabled[] getSSLSessionCacheEnabled(
String[] names
)getSSLSessionCacheEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether use of the session cache is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLSessionCacheEnabled[] getSSLSessionCacheEnabledByLocation(
String location
String[] names
)getSSLSessionTicketsEnabled( names ) throws ObjectDoesNotExist
Get whether use of session tickets is enabled for this virtual server
VirtualServer.SSLSessionTicketsEnabled[] getSSLSessionTicketsEnabled(
String[] names
)getSSLSessionTicketsEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether use of session tickets is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLSessionTicketsEnabled[] getSSLSessionTicketsEnabledByLocation(
String location
String[] names
)getSSLSignatureAlgorithms( names ) throws ObjectDoesNotExist
Get the SSL signature algorithms preference list for SSL connections to this virtual server
String[] getSSLSignatureAlgorithms(
String[] names
)getSSLSignatureAlgorithmsByLocation( location, names ) throws ObjectDoesNotExist
Get the SSL signature algorithms preference list for SSL connections to this virtual server This is a location specific function, any action will operate on the specified location.
String[] getSSLSignatureAlgorithmsByLocation(
String location
String[] names
)getSSLSites( names ) throws ObjectDoesNotExist
Gets a list of mappings between destination addresses and the certificate used for SSL decryption those addresses, for each of the named virtual servers. Each certificate is the name of an item in the SSL Certificates Catalog.
VirtualServer.SSLSite[][] getSSLSites(
String[] names
)getSSLSitesByLocation( location, names ) throws ObjectDoesNotExist
Gets a list of mappings between destination addresses and the certificate used for SSL decryption those addresses, for each of the named virtual servers. Each certificate is the name of an item in the SSL Certificates Catalog. This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLSite[][] getSSLSitesByLocation(
String location
String[] names
)getSSLSitesEx( names ) throws ObjectDoesNotExist
Gets a list of mappings between destination addresses and the default certificate and alt certificates used for SSL decryption those addresses, for each of the named virtual servers. Each certificate is the name of an item in the SSL Certificates Catalog.
VirtualServer.SSLSiteAlt[][] getSSLSitesEx(
String[] names
)getSSLSitesExByLocation( location, names ) throws ObjectDoesNotExist
Gets a list of mappings between destination addresses and the default certificate and alt certificates used for SSL decryption those addresses, for each of the named virtual servers. Each certificate is the name of an item in the SSL Certificates Catalog. This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLSiteAlt[][] getSSLSitesExByLocation(
String location
String[] names
)getSSLSupportSSL2( names ) throws ObjectDoesNotExist
This method is now deprecated.
VirtualServer.SSLSupportSSL2[] getSSLSupportSSL2(
String[] names
)getSSLSupportSSL2ByLocation( location, names ) throws ObjectDoesNotExist
This method is now deprecated. This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLSupportSSL2[] getSSLSupportSSL2ByLocation(
String location
String[] names
)getSSLSupportSSL3( names ) throws ObjectDoesNotExist
Get whether SSLv3 is enabled for this virtual server
VirtualServer.SSLSupportSSL3[] getSSLSupportSSL3(
String[] names
)getSSLSupportSSL3ByLocation( location, names ) throws ObjectDoesNotExist
Get whether SSLv3 is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLSupportSSL3[] getSSLSupportSSL3ByLocation(
String location
String[] names
)getSSLSupportTLS1( names ) throws ObjectDoesNotExist
Get whether TLSv1.0 is enabled for this virtual server
VirtualServer.SSLSupportTLS1[] getSSLSupportTLS1(
String[] names
)getSSLSupportTLS11( names ) throws ObjectDoesNotExist
Get whether TLSv1.1 is enabled for this virtual server
VirtualServer.SSLSupportTLS11[] getSSLSupportTLS11(
String[] names
)getSSLSupportTLS11ByLocation( location, names ) throws ObjectDoesNotExist
Get whether TLSv1.1 is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLSupportTLS11[] getSSLSupportTLS11ByLocation(
String location
String[] names
)getSSLSupportTLS12( names ) throws ObjectDoesNotExist
Get whether TLSv1.2 is enabled for this virtual server
VirtualServer.SSLSupportTLS12[] getSSLSupportTLS12(
String[] names
)getSSLSupportTLS12ByLocation( location, names ) throws ObjectDoesNotExist
Get whether TLSv1.2 is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLSupportTLS12[] getSSLSupportTLS12ByLocation(
String location
String[] names
)getSSLSupportTLS13( names ) throws ObjectDoesNotExist
Get whether TLSv1.3 is enabled for this virtual server
VirtualServer.SSLSupportTLS13[] getSSLSupportTLS13(
String[] names
)getSSLSupportTLS13ByLocation( location, names ) throws ObjectDoesNotExist
Get whether TLSv1.3 is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLSupportTLS13[] getSSLSupportTLS13ByLocation(
String location
String[] names
)getSSLSupportTLS1ByLocation( location, names ) throws ObjectDoesNotExist
Get whether TLSv1.0 is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
VirtualServer.SSLSupportTLS1[] getSSLSupportTLS1ByLocation(
String location
String[] names
)getSSLTrustMagic( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should decode extra information on the true origin of an SSL connection. This information is prefixed onto an incoming SSL connection from another traffic manager.
Boolean[] getSSLTrustMagic(
String[] names
)getSSLTrustMagicByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should decode extra information on the true origin of an SSL connection. This information is prefixed onto an incoming SSL connection from another traffic manager. This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLTrustMagicByLocation(
String location
String[] names
)getSSLUseOCSP( names ) throws ObjectDoesNotExist
Get whether or not the traffic manager should use OCSP to check the revocation status of client certificates
Boolean[] getSSLUseOCSP(
String[] names
)getSSLUseOCSPByLocation( location, names ) throws ObjectDoesNotExist
Get whether or not the traffic manager should use OCSP to check the revocation status of client certificates This is a location specific function, any action will operate on the specified location.
Boolean[] getSSLUseOCSPByLocation(
String location
String[] names
)getServerfirstBanner( names ) throws ObjectDoesNotExist
Get the banner that each of the named virtual servers sends to clients for server-first protocols such as POP, SMTP and IMAP.
String[] getServerfirstBanner(
String[] names
)getServerfirstBannerByLocation( location, names ) throws ObjectDoesNotExist
Get the banner that each of the named virtual servers sends to clients for server-first protocols such as POP, SMTP and IMAP. This is a location specific function, any action will operate on the specified location.
String[] getServerfirstBannerByLocation(
String location
String[] names
)getServiceLevelMonitoring( names ) throws ObjectDoesNotExist
Get the Service Level Monitoring class that each of the named virtual servers uses.
String[] getServiceLevelMonitoring(
String[] names
)getServiceLevelMonitoringByLocation( location, names ) throws ObjectDoesNotExist
Get the Service Level Monitoring class that each of the named virtual servers uses. This is a location specific function, any action will operate on the specified location.
String[] getServiceLevelMonitoringByLocation(
String location
String[] names
)getSipTransactionTimeout( names ) throws ObjectDoesNotExist
Get the time after which an incomplete transaction should be discarded, in seconds, for each of the named virtual servers.
Unsigned Integer[] getSipTransactionTimeout(
String[] names
)getSipTransactionTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the time after which an incomplete transaction should be discarded, in seconds, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getSipTransactionTimeoutByLocation(
String location
String[] names
)getStripXForwardedProtoHeader( names ) throws ObjectDoesNotExist
Get Whether or not the virtual server should strip the \ 'X-Forwarded-Proto' header from incoming requests.
Boolean[] getStripXForwardedProtoHeader(
String[] names
)getStripXForwardedProtoHeaderByLocation( location, names ) throws ObjectDoesNotExist
Get Whether or not the virtual server should strip the \ 'X-Forwarded-Proto' header from incoming requests. This is a location specific function, any action will operate on the specified location.
Boolean[] getStripXForwardedProtoHeaderByLocation(
String location
String[] names
)getTimeout( names ) throws ObjectDoesNotExist
Get the time to wait for data on an already established connection, in seconds, for each of the named virtual servers.
Unsigned Integer[] getTimeout(
String[] names
)getTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the time to wait for data on an already established connection, in seconds, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getTimeoutByLocation(
String location
String[] names
)getTransactionExportBrief( names ) throws ObjectDoesNotExist
Get whether to export a restricted set of metadata about transactions processed by this virtual server. If enabled, more verbose information such as client and server headers and request tracing events will be omitted from the exported data.
Boolean[] getTransactionExportBrief(
String[] names
)getTransactionExportBriefByLocation( location, names ) throws ObjectDoesNotExist
Get whether to export a restricted set of metadata about transactions processed by this virtual server. If enabled, more verbose information such as client and server headers and request tracing events will be omitted from the exported data. This is a location specific function, any action will operate on the specified location.
Boolean[] getTransactionExportBriefByLocation(
String location
String[] names
)getTransactionExportEnabled( names ) throws ObjectDoesNotExist
Get whether to export metadata about transactions handled by this service to the globally configured endpoint.
Boolean[] getTransactionExportEnabled(
String[] names
)getTransactionExportEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether to export metadata about transactions handled by this service to the globally configured endpoint. This is a location specific function, any action will operate on the specified location.
Boolean[] getTransactionExportEnabledByLocation(
String location
String[] names
)getTransactionExportHTTPHeaderBlacklist( names ) throws ObjectDoesNotExist
Get the set of HTTP header names for which corresponding values should be redacted from the metadata exported by this virtual server. from transaction export.
String[][] getTransactionExportHTTPHeaderBlacklist(
String[] names
)getTransactionExportHTTPHeaderBlacklistByLocation( location, names ) throws ObjectDoesNotExist
Get the set of HTTP header names for which corresponding values should be redacted from the metadata exported by this virtual server. from transaction export. This is a location specific function, any action will operate on the specified location.
String[][] getTransactionExportHTTPHeaderBlacklistByLocation(
String location
String[] names
)getTransactionExportHiRes( names ) throws ObjectDoesNotExist
Get whether the transaction processing timeline included in the metadata export is recorded with a high, microsecond, resolution. If set to No, timestamps will be recorded with a resolution of milliseconds.
Boolean[] getTransactionExportHiRes(
String[] names
)getTransactionExportHiResByLocation( location, names ) throws ObjectDoesNotExist
Get whether the transaction processing timeline included in the metadata export is recorded with a high, microsecond, resolution. If set to No, timestamps will be recorded with a resolution of milliseconds. This is a location specific function, any action will operate on the specified location.
Boolean[] getTransactionExportHiResByLocation(
String location
String[] names
)getTransparent( names ) throws ObjectDoesNotExist
Get whether or not bound sockets should be configured for transparent proxying.
Boolean[] getTransparent(
String[] names
)getTransparentByLocation( location, names ) throws ObjectDoesNotExist
Get whether or not bound sockets should be configured for transparent proxying. This is a location specific function, any action will operate on the specified location.
Boolean[] getTransparentByLocation(
String location
String[] names
)getUDPEndTransaction( names ) throws ObjectDoesNotExist
This method is now obsolete.
VirtualServer.UDPEndTransaction[] getUDPEndTransaction(
String[] names
)getUDPEndTransactionByLocation( location, names ) throws ObjectDoesNotExist
This method is now obsolete.
VirtualServer.UDPEndTransaction[] getUDPEndTransactionByLocation(
String location
String[] names
)getUDPEndpointPersistence( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should send UDP datagrams received from the same IP address and port to the same pool node if they match an existing UDP session. Sessions are defined by the protocol being handled, for example SIP datagrams are grouped based on the value of the Call-ID header.
Boolean[] getUDPEndpointPersistence(
String[] names
)getUDPEndpointPersistenceByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should send UDP datagrams received from the same IP address and port to the same pool node if they match an existing UDP session. Sessions are defined by the protocol being handled, for example SIP datagrams are grouped based on the value of the Call-ID header. This is a location specific function, any action will operate on the specified location.
Boolean[] getUDPEndpointPersistenceByLocation(
String location
String[] names
)getUDPRbuffSize( names ) throws ObjectDoesNotExist
Get the socket receive buffer size
Unsigned Integer[] getUDPRbuffSize(
String[] names
)getUDPRbuffSizeByLocation( location, names ) throws ObjectDoesNotExist
Get the socket receive buffer size This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getUDPRbuffSizeByLocation(
String location
String[] names
)getUDPResponseDatagramsExpected( names ) throws ObjectDoesNotExist
Get the expected number of UDP datagrams in the response, for each of the named virtual servers. For simple request/response protocols a value of '1' should be used. If set to -1, the connection will not be discarded until the udp_timeout is reached.
Integer[] getUDPResponseDatagramsExpected(
String[] names
)getUDPResponseDatagramsExpectedByLocation( location, names ) throws ObjectDoesNotExist
Get the expected number of UDP datagrams in the response, for each of the named virtual servers. For simple request/response protocols a value of '1' should be used. If set to -1, the connection will not be discarded until the udp_timeout is reached. This is a location specific function, any action will operate on the specified location.
Integer[] getUDPResponseDatagramsExpectedByLocation(
String location
String[] names
)getUDPTimeout( names ) throws ObjectDoesNotExist
Get the time after which an idle UDP connection should be discarded and resources reclaimed, in seconds, for each of the named virtual servers.
Unsigned Integer[] getUDPTimeout(
String[] names
)getUDPTimeoutByLocation( location, names ) throws ObjectDoesNotExist
Get the time after which an idle UDP connection should be discarded and resources reclaimed, in seconds, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getUDPTimeoutByLocation(
String location
String[] names
)getUDPWbuffSize( names ) throws ObjectDoesNotExist
Get the socket send buffer size
Unsigned Integer[] getUDPWbuffSize(
String[] names
)getUDPWbuffSizeByLocation( location, names ) throws ObjectDoesNotExist
Get the socket send buffer size This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getUDPWbuffSizeByLocation(
String location
String[] names
)getUseNagle( names ) throws ObjectDoesNotExist
Get whether Nagle's algorithm should be used for TCP connections.
Boolean[] getUseNagle(
String[] names
)getUseNagleByLocation( location, names ) throws ObjectDoesNotExist
Get whether Nagle's algorithm should be used for TCP connections. This is a location specific function, any action will operate on the specified location.
Boolean[] getUseNagleByLocation(
String location
String[] names
)getVirtualServerNames()
Gets the names of all the configured virtual servers.
String[] getVirtualServerNames()getWebcacheControlOut( names ) throws ObjectDoesNotExist
Get the Cache-Control header that should be sent with cached HTTP responses.
String[] getWebcacheControlOut(
String[] names
)getWebcacheControlOutByLocation( location, names ) throws ObjectDoesNotExist
Get the Cache-Control header that should be sent with cached HTTP responses. This is a location specific function, any action will operate on the specified location.
String[] getWebcacheControlOutByLocation(
String location
String[] names
)getWebcacheEnabled( names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should attempt to cache web server responses.
Boolean[] getWebcacheEnabled(
String[] names
)getWebcacheEnabledByLocation( location, names ) throws ObjectDoesNotExist
Get whether each of the named virtual servers should attempt to cache web server responses. This is a location specific function, any action will operate on the specified location.
Boolean[] getWebcacheEnabledByLocation(
String location
String[] names
)getWebcacheErrorpageTime( names ) throws ObjectDoesNotExist
Get the time periods that each of the named virtual servers should cache error pages for.
Unsigned Integer[] getWebcacheErrorpageTime(
String[] names
)getWebcacheErrorpageTimeByLocation( location, names ) throws ObjectDoesNotExist
Get the time periods that each of the named virtual servers should cache error pages for. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getWebcacheErrorpageTimeByLocation(
String location
String[] names
)getWebcacheRefreshTime( names ) throws ObjectDoesNotExist
Get the time periods that each of the named virtual servers should consider re-fetching cached pages in.
Unsigned Integer[] getWebcacheRefreshTime(
String[] names
)getWebcacheRefreshTimeByLocation( location, names ) throws ObjectDoesNotExist
Get the time periods that each of the named virtual servers should consider re-fetching cached pages in. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getWebcacheRefreshTimeByLocation(
String location
String[] names
)getWebcacheTime( names ) throws ObjectDoesNotExist
Get the time periods that each of the named virtual servers should cache web pages for.
Unsigned Integer[] getWebcacheTime(
String[] names
)getWebcacheTimeByLocation( location, names ) throws ObjectDoesNotExist
Get the time periods that each of the named virtual servers should cache web pages for. This is a location specific function, any action will operate on the specified location.
Unsigned Integer[] getWebcacheTimeByLocation(
String location
String[] names
)removeCompletionRules( names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, remove rules from the list that are run on the completion of a transaction.
void removeCompletionRules(
String[] names
String[][] rules
)removeCompletionRulesByLocation( location, names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, remove rules from the list that are run on the completion of a transaction. This is a location specific function, any action will operate on the specified location.
void removeCompletionRulesByLocation(
String location
String[] names
String[][] rules
)removeCompressionMIMETypes( names, values ) throws ObjectDoesNotExist, DeploymentError
For each named virtual server, remove new MIME types from the list of types to compress.
void removeCompressionMIMETypes(
String[] names
String[][] values
)removeCompressionMIMETypesByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError
For each named virtual server, remove new MIME types from the list of types to compress. This is a location specific function, any action will operate on the specified location.
void removeCompressionMIMETypesByLocation(
String location
String[] names
String[][] values
)removeDNSZones( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Remove Space separated list of DNS zones
void removeDNSZones(
String[] names
String[][] values
)removeDNSZonesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Remove Space separated list of DNS zones This is a location specific function, any action will operate on the specified location.
void removeDNSZonesByLocation(
String location
String[] names
String[][] values
)removeFTPPortRange( names ) throws ObjectDoesNotExist, DeploymentError
Allow FTP connections to use any free ports, for each of the named virtual servers.
void removeFTPPortRange(
String[] names
)removeFTPPortRangeByLocation( location, names ) throws ObjectDoesNotExist, DeploymentError
Allow FTP connections to use any free ports, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void removeFTPPortRangeByLocation(
String location
String[] names
)removeGLBServices( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Remove GLB Services used by the virtual server
void removeGLBServices(
String[] names
String[][] values
)removeGLBServicesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Remove GLB Services used by the virtual server This is a location specific function, any action will operate on the specified location.
void removeGLBServicesByLocation(
String location
String[] names
String[][] values
)removeHTTP2HeadersIndexBlacklist( names, values ) throws ObjectDoesNotExist, DeploymentError
Remove a list of header names that should never be compressed using indexing.
void removeHTTP2HeadersIndexBlacklist(
String[] names
String[][] values
)removeHTTP2HeadersIndexBlacklistByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError
Remove a list of header names that should never be compressed using indexing. This is a location specific function, any action will operate on the specified location.
void removeHTTP2HeadersIndexBlacklistByLocation(
String location
String[] names
String[][] values
)removeHTTP2HeadersIndexWhitelist( names, values ) throws ObjectDoesNotExist, DeploymentError
Remove a list of header names that can be compressed using indexing when the default is to never index.
void removeHTTP2HeadersIndexWhitelist(
String[] names
String[][] values
)removeHTTP2HeadersIndexWhitelistByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError
Remove a list of header names that can be compressed using indexing when the default is to never index. This is a location specific function, any action will operate on the specified location.
void removeHTTP2HeadersIndexWhitelistByLocation(
String location
String[] names
String[][] values
)removeRTSPPortRange( names ) throws ObjectDoesNotExist, DeploymentError
Allow any free ports to be used for RTSP connections, for each of the named virtual servers.
void removeRTSPPortRange(
String[] names
)removeRTSPPortRangeByLocation( location, names ) throws ObjectDoesNotExist, DeploymentError
Allow any free ports to be used for RTSP connections, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void removeRTSPPortRangeByLocation(
String location
String[] names
)removeResponseRules( names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, remove rules from the list that are run on server responses.
void removeResponseRules(
String[] names
String[][] rules
)removeResponseRulesByLocation( location, names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, remove rules from the list that are run on server responses. This is a location specific function, any action will operate on the specified location.
void removeResponseRulesByLocation(
String location
String[] names
String[][] rules
)removeRules( names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, remove rules from the list of rules that are run on client requests.
void removeRules(
String[] names
String[][] rules
)removeRulesByLocation( location, names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, remove rules from the list of rules that are run on client requests. This is a location specific function, any action will operate on the specified location.
void removeRulesByLocation(
String location
String[] names
String[][] rules
)removeSIPPortRange( names ) throws ObjectDoesNotExist, DeploymentError
Allow any free ports to be used for SIP connections, for each of the named virtual servers. This setting is only used when the SIP virtual server is using 'Full Gateway' mode.
void removeSIPPortRange(
String[] names
)removeSIPPortRangeByLocation( location, names ) throws ObjectDoesNotExist, DeploymentError
Allow any free ports to be used for SIP connections, for each of the named virtual servers. This setting is only used when the SIP virtual server is using 'Full Gateway' mode. This is a location specific function, any action will operate on the specified location.
void removeSIPPortRangeByLocation(
String location
String[] names
)removeSSLClientCertificateAuthorities( names, values ) throws ObjectDoesNotExist, DeploymentError
Remove certificate authorities for validating client certificates for each of the named virtual servers.
void removeSSLClientCertificateAuthorities(
String[] names
String[][] values
)removeSSLClientCertificateAuthoritiesByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError
Remove certificate authorities for validating client certificates for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void removeSSLClientCertificateAuthoritiesByLocation(
String location
String[] names
String[][] values
)removeSSLNeverExpiringClientCertificateAuthorities( names, values ) throws ObjectDoesNotExist, DeploymentError
Remove CAs for which any client certificate they validate is considered valid even if the client certificate's expiration date has passed, for each of the named virtual servers.
void removeSSLNeverExpiringClientCertificateAuthorities(
String[] names
String[][] values
)removeSSLNeverExpiringClientCertificateAuthoritiesByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError
Remove CAs for which any client certificate they validate is considered valid even if the client certificate's expiration date has passed, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void removeSSLNeverExpiringClientCertificateAuthoritiesByLocation(
String location
String[] names
String[][] values
)removeSSLOCSPIssuers( names, cas ) throws ObjectDoesNotExist, DeploymentError
Removes mappings between OCSP responder settings for the specified Certificate authorities
void removeSSLOCSPIssuers(
String[] names
String[][] cas
)removeSSLOCSPIssuersByLocation( location, names, cas ) throws ObjectDoesNotExist, DeploymentError
Removes mappings between OCSP responder settings for the specified Certificate authorities This is a location specific function, any action will operate on the specified location.
void removeSSLOCSPIssuersByLocation(
String location
String[] names
String[][] cas
)removeTransactionExportHTTPHeaderBlacklist( names, values ) throws ObjectDoesNotExist, DeploymentError
Remove the set of HTTP header names for which corresponding values should be redacted from the metadata exported by this virtual server. from transaction export.
void removeTransactionExportHTTPHeaderBlacklist(
String[] names
String[][] values
)removeTransactionExportHTTPHeaderBlacklistByLocation( location, names, values ) throws ObjectDoesNotExist, DeploymentError
Remove the set of HTTP header names for which corresponding values should be redacted from the metadata exported by this virtual server. from transaction export. This is a location specific function, any action will operate on the specified location.
void removeTransactionExportHTTPHeaderBlacklistByLocation(
String location
String[] names
String[][] values
)renameVirtualServer( names, new_names ) throws ObjectDoesNotExist, InvalidObjectName, DeploymentError, InvalidOperation
Rename each of the named virtual servers.
void renameVirtualServer(
String[] names
String[] new_names
)setAddClusterClientIPHeader( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether an 'X-Cluster-Client-Ip' header should be added to each HTTP request, for each of the named virtual servers. The 'X-Cluster-Client-Ip' header contains the client's IP address.
void setAddClusterClientIPHeader(
String[] names
Boolean[] values
)setAddClusterClientIPHeaderByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether an 'X-Cluster-Client-Ip' header should be added to each HTTP request, for each of the named virtual servers. The 'X-Cluster-Client-Ip' header contains the client's IP address. This is a location specific function, any action will operate on the specified location.
void setAddClusterClientIPHeaderByLocation(
String location
String[] names
Boolean[] values
)setAddXForwardedForHeader( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the remote client's IP address should be appended to the X-Forwarded-For header. The 'X-Forwarded-For' header contains the client's IP address.
void setAddXForwardedForHeader(
String[] names
Boolean[] values
)setAddXForwardedForHeaderByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the remote client's IP address should be appended to the X-Forwarded-For header. The 'X-Forwarded-For' header contains the client's IP address. This is a location specific function, any action will operate on the specified location.
void setAddXForwardedForHeaderByLocation(
String location
String[] names
Boolean[] values
)setAddXForwardedProtoHeader( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether an 'X-Forwarded-Proto' header should be added to each HTTP request, for each of the named virtual servers. The 'X-Forwarded-Proto' header contains the protocol the client used to connect to the traffic manager
void setAddXForwardedProtoHeader(
String[] names
Boolean[] values
)setAddXForwardedProtoHeaderByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether an 'X-Forwarded-Proto' header should be added to each HTTP request, for each of the named virtual servers. The 'X-Forwarded-Proto' header contains the protocol the client used to connect to the traffic manager This is a location specific function, any action will operate on the specified location.
void setAddXForwardedProtoHeaderByLocation(
String location
String[] names
Boolean[] values
)setApplicationFirewallEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, InvalidOperation, LicenseError
For each of the named virtual servers, enable or disable the Web Application Firewall.
void setApplicationFirewallEnabled(
String[] names
Boolean[] values
)setApplicationFirewallEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, InvalidOperation, LicenseError
For each of the named virtual servers, enable or disable the Web Application Firewall. This is a location specific function, any action will operate on the specified location.
void setApplicationFirewallEnabledByLocation(
String location
String[] names
Boolean[] values
)setAptimizerEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should optimize web content.
void setAptimizerEnabled(
String[] names
Boolean[] values
)setAptimizerEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should optimize web content. This is a location specific function, any action will operate on the specified location.
void setAptimizerEnabledByLocation(
String location
String[] names
Boolean[] values
)setAuthSamlIdp( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the name of the Trusted Identity Provider configuration to use.
void setAuthSamlIdp(
String[] names
String[] values
)setAuthSamlIdpByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the name of the Trusted Identity Provider configuration to use. This is a location specific function, any action will operate on the specified location.
void setAuthSamlIdpByLocation(
String location
String[] names
String[] values
)setAuthSamlNameIdFormat( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the desired nameid format.
void setAuthSamlNameIdFormat(
String[] names
VirtualServer.AuthSamlNameIdFormat[] values
)setAuthSamlNameIdFormatByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the desired nameid format. This is a location specific function, any action will operate on the specified location.
void setAuthSamlNameIdFormatByLocation(
String location
String[] names
VirtualServer.AuthSamlNameIdFormat[] values
)setAuthSamlSpAcsUrl( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the URL of the assertion consumer service.
void setAuthSamlSpAcsUrl(
String[] names
String[] values
)setAuthSamlSpAcsUrlByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the URL of the assertion consumer service. This is a location specific function, any action will operate on the specified location.
void setAuthSamlSpAcsUrlByLocation(
String location
String[] names
String[] values
)setAuthSamlSpEntityId( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the entity id of this service provider.
void setAuthSamlSpEntityId(
String[] names
String[] values
)setAuthSamlSpEntityIdByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the entity id of this service provider. This is a location specific function, any action will operate on the specified location.
void setAuthSamlSpEntityIdByLocation(
String location
String[] names
String[] values
)setAuthSamlTimeTolerance( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time tolerance on authentication checks (in seconds)
void setAuthSamlTimeTolerance(
String[] names
Unsigned Integer[] values
)setAuthSamlTimeToleranceByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time tolerance on authentication checks (in seconds) This is a location specific function, any action will operate on the specified location.
void setAuthSamlTimeToleranceByLocation(
String location
String[] names
Unsigned Integer[] values
)setAuthSessionCookieAttributes( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the attributes of the cookie used for the authentication session.
void setAuthSessionCookieAttributes(
String[] names
String[] values
)setAuthSessionCookieAttributesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the attributes of the cookie used for the authentication session. This is a location specific function, any action will operate on the specified location.
void setAuthSessionCookieAttributesByLocation(
String location
String[] names
String[] values
)setAuthSessionCookieName( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the name of the cookie used for the authentication session.
void setAuthSessionCookieName(
String[] names
String[] values
)setAuthSessionCookieNameByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the name of the cookie used for the authentication session. This is a location specific function, any action will operate on the specified location.
void setAuthSessionCookieNameByLocation(
String location
String[] names
String[] values
)setAuthSessionLogExternalState( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set plaintext logging of encrypted authentication session state
void setAuthSessionLogExternalState(
String[] names
Boolean[] values
)setAuthSessionLogExternalStateByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set plaintext logging of encrypted authentication session state This is a location specific function, any action will operate on the specified location.
void setAuthSessionLogExternalStateByLocation(
String location
String[] names
Boolean[] values
)setAuthSessionTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the authentication session timeout (in seconds)
void setAuthSessionTimeout(
String[] names
Unsigned Integer[] values
)setAuthSessionTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the authentication session timeout (in seconds) This is a location specific function, any action will operate on the specified location.
void setAuthSessionTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setAuthType( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the type of authentication to apply to requests to the virtual server.
void setAuthType(
String[] names
VirtualServer.AuthType[] values
)setAuthTypeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the type of authentication to apply to requests to the virtual server. This is a location specific function, any action will operate on the specified location.
void setAuthTypeByLocation(
String location
String[] names
VirtualServer.AuthType[] values
)setAuthVerbose( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether vserver authentication events should be logged in detail
void setAuthVerbose(
String[] names
Boolean[] values
)setAuthVerboseByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether vserver authentication events should be logged in detail This is a location specific function, any action will operate on the specified location.
void setAuthVerboseByLocation(
String location
String[] names
Boolean[] values
)setAutodetectUpgradeHeaders( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the traffic manager should check for HTTP responses that confirm an upgrade to the WebSockets protocol and automatically stop any protocol-specific processing for that connection when detected.
void setAutodetectUpgradeHeaders(
String[] names
Boolean[] values
)setAutodetectUpgradeHeadersByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the traffic manager should check for HTTP responses that confirm an upgrade to the WebSockets protocol and automatically stop any protocol-specific processing for that connection when detected. This is a location specific function, any action will operate on the specified location.
void setAutodetectUpgradeHeadersByLocation(
String location
String[] names
Boolean[] values
)setBandwidthClass( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Bandwidth Class that each of the named virtual servers uses.
void setBandwidthClass(
String[] names
String[] values
)setBandwidthClassByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Bandwidth Class that each of the named virtual servers uses. This is a location specific function, any action will operate on the specified location.
void setBandwidthClassByLocation(
String location
String[] names
String[] values
)setBypassDataPlaneAcceleration( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setBypassDataPlaneAcceleration(
String[] names
Boolean[] values
)setBypassDataPlaneAccelerationByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setBypassDataPlaneAccelerationByLocation(
String location
String[] names
Boolean[] values
)setCloseWithRst( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether connections from clients should be closed with a RST packet, rather than a FIN packet, avoiding the TIME_WAIT state.
void setCloseWithRst(
String[] names
Boolean[] values
)setCloseWithRstByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether connections from clients should be closed with a RST packet, rather than a FIN packet, avoiding the TIME_WAIT state. This is a location specific function, any action will operate on the specified location.
void setCloseWithRstByLocation(
String location
String[] names
Boolean[] values
)setCompletionRules( names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the rules that are run on the completion of a transaction for each of the named virtual servers.
void setCompletionRules(
String[] names
VirtualServer.Rule[][] rules
)setCompletionRulesByLocation( location, names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the rules that are run on the completion of a transaction for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setCompletionRulesByLocation(
String location
String[] names
VirtualServer.Rule[][] rules
)setCompressUnknownSize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should compress documents with no given size.
void setCompressUnknownSize(
String[] names
Boolean[] values
)setCompressUnknownSizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should compress documents with no given size. This is a location specific function, any action will operate on the specified location.
void setCompressUnknownSizeByLocation(
String location
String[] names
Boolean[] values
)setCompressionETagRewrite( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set how the ETag header should be manipulated when compressing content.
void setCompressionETagRewrite(
String[] names
VirtualServer.CompressionETagRewrite[] values
)setCompressionETagRewriteByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set how the ETag header should be manipulated when compressing content. This is a location specific function, any action will operate on the specified location.
void setCompressionETagRewriteByLocation(
String location
String[] names
VirtualServer.CompressionETagRewrite[] values
)setCompressionEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should compress web pages before sending to the client.
void setCompressionEnabled(
String[] names
Boolean[] values
)setCompressionEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should compress web pages before sending to the client. This is a location specific function, any action will operate on the specified location.
void setCompressionEnabledByLocation(
String location
String[] names
Boolean[] values
)setCompressionLevel( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the gzip compression level, for each of the named virtual servers.
void setCompressionLevel(
String[] names
Unsigned Integer[] values
)setCompressionLevelByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the gzip compression level, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setCompressionLevelByLocation(
String location
String[] names
Unsigned Integer[] values
)setCompressionMIMETypes( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the list of MIME types to compress, for each of the named virtual servers.
void setCompressionMIMETypes(
String[] names
String[][] values
)setCompressionMIMETypesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the list of MIME types to compress, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setCompressionMIMETypesByLocation(
String location
String[] names
String[][] values
)setCompressionMaxSize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the maximum document size to compress, in bytes, for each of the named virtual servers. A document size of '0' means 'unlimited'.
void setCompressionMaxSize(
String[] names
Unsigned Integer[] values
)setCompressionMaxSizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the maximum document size to compress, in bytes, for each of the named virtual servers. A document size of '0' means 'unlimited'. This is a location specific function, any action will operate on the specified location.
void setCompressionMaxSizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setCompressionMinSize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the minimum document size to compress, in bytes, for each of the named virtual servers.
void setCompressionMinSize(
String[] names
Unsigned Integer[] values
)setCompressionMinSizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the minimum document size to compress, in bytes, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setCompressionMinSizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setConnectTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time, in seconds, for which an established connection can remain idle waiting for some initial data to be received from the client. The initial data is defined as a complete set of request headers for HTTP, SIP and RTSP services, or the first byte of data for all other services. A value of 0 will disable the timeout.
void setConnectTimeout(
String[] names
Unsigned Integer[] values
)setConnectTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time, in seconds, for which an established connection can remain idle waiting for some initial data to be received from the client. The initial data is defined as a complete set of request headers for HTTP, SIP and RTSP services, or the first byte of data for all other services. A value of 0 will disable the timeout. This is a location specific function, any action will operate on the specified location.
void setConnectTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setCookieDomainRewriteMode( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set how each of the named virtual servers should rewrite the domain portion of cookies set by a back-end web server.
void setCookieDomainRewriteMode(
String[] names
VirtualServer.CookieDomainRewriteMode[] values
)setCookieDomainRewriteModeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set how each of the named virtual servers should rewrite the domain portion of cookies set by a back-end web server. This is a location specific function, any action will operate on the specified location.
void setCookieDomainRewriteModeByLocation(
String location
String[] names
VirtualServer.CookieDomainRewriteMode[] values
)setCookieNamedDomain( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the domain to use when rewriting cookie domains, for each of the named virtual servers.
void setCookieNamedDomain(
String[] names
String[] values
)setCookieNamedDomainByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the domain to use when rewriting cookie domains, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setCookieNamedDomainByLocation(
String location
String[] names
String[] values
)setCookiePathRewrite( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, set the regex, and replacement for rewriting the path portion of a cookie.
void setCookiePathRewrite(
String[] names
VirtualServer.RegexReplacement[] values
)setCookiePathRewriteByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, set the regex, and replacement for rewriting the path portion of a cookie. This is a location specific function, any action will operate on the specified location.
void setCookiePathRewriteByLocation(
String location
String[] names
VirtualServer.RegexReplacement[] values
)setCookieSecureFlagRewriteMode( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should modify the 'secure' tag of cookies set by a back-end web server.
void setCookieSecureFlagRewriteMode(
String[] names
VirtualServer.CookieSecureFlagRewriteMode[] values
)setCookieSecureFlagRewriteModeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should modify the 'secure' tag of cookies set by a back-end web server. This is a location specific function, any action will operate on the specified location.
void setCookieSecureFlagRewriteModeByLocation(
String location
String[] names
VirtualServer.CookieSecureFlagRewriteMode[] values
)setDNSEdnsClientSubnet( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether use of EDNS client subnet option is enabled
void setDNSEdnsClientSubnet(
String[] names
Boolean[] values
)setDNSEdnsClientSubnetByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether use of EDNS client subnet option is enabled This is a location specific function, any action will operate on the specified location.
void setDNSEdnsClientSubnetByLocation(
String location
String[] names
Boolean[] values
)setDNSEdnsUdpsize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set EDNS UDP size advertised in responses
void setDNSEdnsUdpsize(
String[] names
Unsigned Integer[] values
)setDNSEdnsUdpsizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set EDNS UDP size advertised in responses This is a location specific function, any action will operate on the specified location.
void setDNSEdnsUdpsizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setDNSMaxUdpsize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set Maximum UDP answer size
void setDNSMaxUdpsize(
String[] names
Unsigned Integer[] values
)setDNSMaxUdpsizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set Maximum UDP answer size This is a location specific function, any action will operate on the specified location.
void setDNSMaxUdpsizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setDNSRecordsetOrder( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set order of records in a DNS response
void setDNSRecordsetOrder(
String[] names
VirtualServer.DNSRecordsetOrder[] values
)setDNSRecordsetOrderByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set order of records in a DNS response This is a location specific function, any action will operate on the specified location.
void setDNSRecordsetOrderByLocation(
String location
String[] names
VirtualServer.DNSRecordsetOrder[] values
)setDNSVerbose( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether built-in DNS server should log verbose messges
void setDNSVerbose(
String[] names
Boolean[] values
)setDNSVerboseByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether built-in DNS server should log verbose messges This is a location specific function, any action will operate on the specified location.
void setDNSVerboseByLocation(
String location
String[] names
Boolean[] values
)setDNSZones( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set Space separated list of DNS zones
void setDNSZones(
String[] names
String[][] values
)setDNSZonesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set Space separated list of DNS zones This is a location specific function, any action will operate on the specified location.
void setDNSZonesByLocation(
String location
String[] names
String[][] values
)setDefaultPool( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the default Pool that traffic is sent to for each of the named virtual servers.
void setDefaultPool(
String[] names
String[] values
)setDefaultPoolByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the default Pool that traffic is sent to for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setDefaultPoolByLocation(
String location
String[] names
String[] values
)setEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers is enabled (i.e. serving traffic).
void setEnabled(
String[] names
Boolean[] values
)setEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers is enabled (i.e. serving traffic). This is a location specific function, any action will operate on the specified location.
void setEnabledByLocation(
String location
String[] names
Boolean[] values
)setErrorFile( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the file names of the error texts that each of the named virtual servers will send back to a client in case of back-end or internal errors.
void setErrorFile(
String[] names
String[] values
)setErrorFileByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the file names of the error texts that each of the named virtual servers will send back to a client in case of back-end or internal errors. This is a location specific function, any action will operate on the specified location.
void setErrorFileByLocation(
String location
String[] names
String[] values
)setFTPDataSourcePort( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the source port each of the named virtual servers should use for active-mode FTP data connections. If 0, a random high port will be used, otherwise the specified port will be used. If a port below 1024 is required you must first explicitly permit use of low ports with the ftp_data_bind_low global setting.
void setFTPDataSourcePort(
String[] names
Unsigned Integer[] values
)setFTPDataSourcePortByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the source port each of the named virtual servers should use for active-mode FTP data connections. If 0, a random high port will be used, otherwise the specified port will be used. If a port below 1024 is required you must first explicitly permit use of low ports with the ftp_data_bind_low global setting. This is a location specific function, any action will operate on the specified location.
void setFTPDataSourcePortByLocation(
String location
String[] names
Unsigned Integer[] values
)setFTPForceClientSecure( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should require incoming FTP data connections (from clients) to originate from the same IP address as the corresponding control connection.
void setFTPForceClientSecure(
String[] names
Boolean[] values
)setFTPForceClientSecureByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should require incoming FTP data connections (from clients) to originate from the same IP address as the corresponding control connection. This is a location specific function, any action will operate on the specified location.
void setFTPForceClientSecureByLocation(
String location
String[] names
Boolean[] values
)setFTPForceServerSecure( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should require incoming FTP data connections (from nodes) to originate from the same IP address as the corresponding control connection.
void setFTPForceServerSecure(
String[] names
Boolean[] values
)setFTPForceServerSecureByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should require incoming FTP data connections (from nodes) to originate from the same IP address as the corresponding control connection. This is a location specific function, any action will operate on the specified location.
void setFTPForceServerSecureByLocation(
String location
String[] names
Boolean[] values
)setFTPPortRange( names, range ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the port range used for FTP data connections for each of the named virtual servers.
void setFTPPortRange(
String[] names
VirtualServer.FTPPortRange[] range
)setFTPPortRangeByLocation( location, names, range ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the port range used for FTP data connections for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setFTPPortRangeByLocation(
String location
String[] names
VirtualServer.FTPPortRange[] range
)setFTPSSLData( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should use SSL on the data connection as well as the control connection
void setFTPSSLData(
String[] names
Boolean[] values
)setFTPSSLDataByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should use SSL on the data connection as well as the control connection This is a location specific function, any action will operate on the specified location.
void setFTPSSLDataByLocation(
String location
String[] names
Boolean[] values
)setGLBServices( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set GLB Services used by the virtual server
void setGLBServices(
String[] names
String[][] values
)setGLBServicesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set GLB Services used by the virtual server This is a location specific function, any action will operate on the specified location.
void setGLBServicesByLocation(
String location
String[] names
String[][] values
)setHTTP2ClientBufferMultiplier( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the amount of memory used to store data sent by the client, in multiples of max_client_buffer, for a HTTP/2 connection.
void setHTTP2ClientBufferMultiplier(
String[] names
Unsigned Integer[] values
)setHTTP2ClientBufferMultiplierByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the amount of memory used to store data sent by the client, in multiples of max_client_buffer, for a HTTP/2 connection. This is a location specific function, any action will operate on the specified location.
void setHTTP2ClientBufferMultiplierByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2ConnectTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time to wait for a request on a new HTTP/2 connection, in seconds. If no request is received in this time, the connection will be closed. This setting overrides 'connect_timeout', and uses the value of 'connect_timeout' if set to zero.
void setHTTP2ConnectTimeout(
String[] names
Unsigned Integer[] values
)setHTTP2ConnectTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time to wait for a request on a new HTTP/2 connection, in seconds. If no request is received in this time, the connection will be closed. This setting overrides 'connect_timeout', and uses the value of 'connect_timeout' if set to zero. This is a location specific function, any action will operate on the specified location.
void setHTTP2ConnectTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2DataFrameSize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the preferred HTTP/2 data frame size
void setHTTP2DataFrameSize(
String[] names
Unsigned Integer[] values
)setHTTP2DataFrameSizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the preferred HTTP/2 data frame size This is a location specific function, any action will operate on the specified location.
void setHTTP2DataFrameSizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2Enabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set allows the HTTP/2 protocol to be used.
void setHTTP2Enabled(
String[] names
Boolean[] values
)setHTTP2EnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set allows the HTTP/2 protocol to be used. This is a location specific function, any action will operate on the specified location.
void setHTTP2EnabledByLocation(
String location
String[] names
Boolean[] values
)setHTTP2HeaderTableSize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the amount of memory allowed for header compression
void setHTTP2HeaderTableSize(
String[] names
Unsigned Integer[] values
)setHTTP2HeaderTableSizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the amount of memory allowed for header compression This is a location specific function, any action will operate on the specified location.
void setHTTP2HeaderTableSizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2HeadersIndexBlacklist( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set a list of header names that should never be compressed using indexing.
void setHTTP2HeadersIndexBlacklist(
String[] names
String[][] values
)setHTTP2HeadersIndexBlacklistByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set a list of header names that should never be compressed using indexing. This is a location specific function, any action will operate on the specified location.
void setHTTP2HeadersIndexBlacklistByLocation(
String location
String[] names
String[][] values
)setHTTP2HeadersIndexDefault( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether all HTTP/2 headers should be compressed using indexing, except those specified in the blacklist, or whether all HTTP/2 headers should not be compressed using indexing, except those specified in the whitelist.
void setHTTP2HeadersIndexDefault(
String[] names
Boolean[] values
)setHTTP2HeadersIndexDefaultByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether all HTTP/2 headers should be compressed using indexing, except those specified in the blacklist, or whether all HTTP/2 headers should not be compressed using indexing, except those specified in the whitelist. This is a location specific function, any action will operate on the specified location.
void setHTTP2HeadersIndexDefaultByLocation(
String location
String[] names
Boolean[] values
)setHTTP2HeadersIndexWhitelist( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set a list of header names that can be compressed using indexing when the default is to never index.
void setHTTP2HeadersIndexWhitelist(
String[] names
String[][] values
)setHTTP2HeadersIndexWhitelistByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set a list of header names that can be compressed using indexing when the default is to never index. This is a location specific function, any action will operate on the specified location.
void setHTTP2HeadersIndexWhitelistByLocation(
String location
String[] names
String[][] values
)setHTTP2HeadersSizeLimit( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the maximum size, in bytes, of decompressed headers for an HTTP/2 request.
void setHTTP2HeadersSizeLimit(
String[] names
Unsigned Integer[] values
)setHTTP2HeadersSizeLimitByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the maximum size, in bytes, of decompressed headers for an HTTP/2 request. This is a location specific function, any action will operate on the specified location.
void setHTTP2HeadersSizeLimitByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2IdleTimeoutNoStreams( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time to wait for an HTTP/2 request on a previously used HTTP/2 connection with no open streams.
void setHTTP2IdleTimeoutNoStreams(
String[] names
Unsigned Integer[] values
)setHTTP2IdleTimeoutNoStreamsByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time to wait for an HTTP/2 request on a previously used HTTP/2 connection with no open streams. This is a location specific function, any action will operate on the specified location.
void setHTTP2IdleTimeoutNoStreamsByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2IdleTimeoutOpenStreams( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time to wait for data on an HTTP/2 connection with open streams that haven't sent data recently
void setHTTP2IdleTimeoutOpenStreams(
String[] names
Unsigned Integer[] values
)setHTTP2IdleTimeoutOpenStreamsByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time to wait for data on an HTTP/2 connection with open streams that haven't sent data recently This is a location specific function, any action will operate on the specified location.
void setHTTP2IdleTimeoutOpenStreamsByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2MaxConcurrentStreams( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the number of concurrent streams allowed
void setHTTP2MaxConcurrentStreams(
String[] names
Unsigned Integer[] values
)setHTTP2MaxConcurrentStreamsByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the number of concurrent streams allowed This is a location specific function, any action will operate on the specified location.
void setHTTP2MaxConcurrentStreamsByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2MaxFrameSize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the maximum HTTP/2 frame size
void setHTTP2MaxFrameSize(
String[] names
Unsigned Integer[] values
)setHTTP2MaxFrameSizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the maximum HTTP/2 frame size This is a location specific function, any action will operate on the specified location.
void setHTTP2MaxFrameSizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2MaxHeaderPadding( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the maximum size, in bytes, of random-length padding to add to HTTP/2 header frames
void setHTTP2MaxHeaderPadding(
String[] names
Unsigned Integer[] values
)setHTTP2MaxHeaderPaddingByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the maximum size, in bytes, of random-length padding to add to HTTP/2 header frames This is a location specific function, any action will operate on the specified location.
void setHTTP2MaxHeaderPaddingByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2MergeCookieHeaders( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether Cookie headers received from an HTTP/2 client should be merged into a single Cookie header before forwarding to an HTTP/1.1 server.
void setHTTP2MergeCookieHeaders(
String[] names
Boolean[] values
)setHTTP2MergeCookieHeadersByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether Cookie headers received from an HTTP/2 client should be merged into a single Cookie header before forwarding to an HTTP/1.1 server. This is a location specific function, any action will operate on the specified location.
void setHTTP2MergeCookieHeadersByLocation(
String location
String[] names
Boolean[] values
)setHTTP2ServerBufferMultiplier( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the amount of memory used to store data sent by the server, in multiples of max_server_buffer, for a HTTP/2 connection.
void setHTTP2ServerBufferMultiplier(
String[] names
Unsigned Integer[] values
)setHTTP2ServerBufferMultiplierByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the amount of memory used to store data sent by the server, in multiples of max_server_buffer, for a HTTP/2 connection. This is a location specific function, any action will operate on the specified location.
void setHTTP2ServerBufferMultiplierByLocation(
String location
String[] names
Unsigned Integer[] values
)setHTTP2StreamWindowSize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the flow control window size
void setHTTP2StreamWindowSize(
String[] names
Unsigned Integer[] values
)setHTTP2StreamWindowSizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the flow control window size This is a location specific function, any action will operate on the specified location.
void setHTTP2StreamWindowSizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setHttpChunkOverheadForwarding( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set how to handle forwarding of data that is pure HTTP chunking overhead.
void setHttpChunkOverheadForwarding(
String[] names
VirtualServer.HttpChunkOverheadForwarding[] values
)setHttpChunkOverheadForwardingByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set how to handle forwarding of data that is pure HTTP chunking overhead. This is a location specific function, any action will operate on the specified location.
void setHttpChunkOverheadForwardingByLocation(
String location
String[] names
VirtualServer.HttpChunkOverheadForwarding[] values
)setKeepalive( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should allow clients to maintain keepalive connections.
void setKeepalive(
String[] names
Boolean[] values
)setKeepaliveByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should allow clients to maintain keepalive connections. This is a location specific function, any action will operate on the specified location.
void setKeepaliveByLocation(
String location
String[] names
Boolean[] values
)setKeepaliveTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time that an idle keepalive connection should be kept open for, in seconds, for each of the named virtual servers.
void setKeepaliveTimeout(
String[] names
Unsigned Integer[] values
)setKeepaliveTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time that an idle keepalive connection should be kept open for, in seconds, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setKeepaliveTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setKerberosProtocolTransitionEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Sets whether each of the named virtual servers should use Kerberos Protocol Transition.
void setKerberosProtocolTransitionEnabled(
String[] names
Boolean[] values
)setKerberosProtocolTransitionEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Sets whether each of the named virtual servers should use Kerberos Protocol Transition. This is a location specific function, any action will operate on the specified location.
void setKerberosProtocolTransitionEnabledByLocation(
String location
String[] names
Boolean[] values
)setKerberosProtocolTransitionPrincipal( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Kerberos principal that each of the named virtual servers uses to perform Kerberos Protocol Transition
void setKerberosProtocolTransitionPrincipal(
String[] names
String[] values
)setKerberosProtocolTransitionPrincipalByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Kerberos principal that each of the named virtual servers uses to perform Kerberos Protocol Transition This is a location specific function, any action will operate on the specified location.
void setKerberosProtocolTransitionPrincipalByLocation(
String location
String[] names
String[] values
)setKerberosProtocolTransitionTarget( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Kerberos principal name of the service that each of the named virtual servers targets
void setKerberosProtocolTransitionTarget(
String[] names
String[] values
)setKerberosProtocolTransitionTargetByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Kerberos principal name of the service that each of the named virtual servers targets This is a location specific function, any action will operate on the specified location.
void setKerberosProtocolTransitionTargetByLocation(
String location
String[] names
String[] values
)setL4AccelRSTOnServiceFailure( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelRSTOnServiceFailure(
String[] names
Boolean[] values
)setL4AccelRSTOnServiceFailureByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelRSTOnServiceFailureByLocation(
String location
String[] names
Boolean[] values
)setL4AccelServiceIPSNAT( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelServiceIPSNAT(
String[] names
Boolean[] values
)setL4AccelServiceIPSNATByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelServiceIPSNATByLocation(
String location
String[] names
Boolean[] values
)setL4AccelStateSync( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelStateSync(
String[] names
Boolean[] values
)setL4AccelStateSyncByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelStateSyncByLocation(
String location
String[] names
Boolean[] values
)setL4AccelTCPMaxSegmentLifetime( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelTCPMaxSegmentLifetime(
String[] names
Unsigned Integer[] values
)setL4AccelTCPMaxSegmentLifetimeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelTCPMaxSegmentLifetimeByLocation(
String location
String[] names
Unsigned Integer[] values
)setL4AccelTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelTimeout(
String[] names
Unsigned Integer[] values
)setL4AccelTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setL4AccelUDPCountRequests( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelUDPCountRequests(
String[] names
Boolean[] values
)setL4AccelUDPCountRequestsByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setL4AccelUDPCountRequestsByLocation(
String location
String[] names
Boolean[] values
)setListenAddresses( names, addresses ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the specific IP addresses and hostnames for each named virtual server to listen on.
void setListenAddresses(
String[] names
String[][] addresses
)setListenAddressesByLocation( location, names, addresses ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the specific IP addresses and hostnames for each named virtual server to listen on. This is a location specific function, any action will operate on the specified location.
void setListenAddressesByLocation(
String location
String[] names
String[][] addresses
)setListenOnAllAddresses( names ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Make each of the named virtual servers listen on all IP addresses.
void setListenOnAllAddresses(
String[] names
)setListenOnAllAddressesByLocation( location, names ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Make each of the named virtual servers listen on all IP addresses. This is a location specific function, any action will operate on the specified location.
void setListenOnAllAddressesByLocation(
String location
String[] names
)setListenTrafficIPGroups( names, groups ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, set specific Traffic IP Groups for it to listen on.
void setListenTrafficIPGroups(
String[] names
String[][] groups
)setListenTrafficIPGroupsByLocation( location, names, groups ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, set specific Traffic IP Groups for it to listen on. This is a location specific function, any action will operate on the specified location.
void setListenTrafficIPGroupsByLocation(
String location
String[] names
String[][] groups
)setLocationDefaultRewriteMode( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should rewrite the 'Location' header. The rewrite is only performed if the location rewrite regex didn't match.
void setLocationDefaultRewriteMode(
String[] names
VirtualServer.LocationDefaultRewriteMode[] values
)setLocationDefaultRewriteModeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should rewrite the 'Location' header. The rewrite is only performed if the location rewrite regex didn't match. This is a location specific function, any action will operate on the specified location.
void setLocationDefaultRewriteModeByLocation(
String location
String[] names
VirtualServer.LocationDefaultRewriteMode[] values
)setLocationRewrite( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, set the regex, and replacement for rewriting any 'Location' headers.
void setLocationRewrite(
String[] names
VirtualServer.RegexReplacement[] values
)setLocationRewriteByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
For each of the named virtual servers, set the regex, and replacement for rewriting any 'Location' headers. This is a location specific function, any action will operate on the specified location.
void setLocationRewriteByLocation(
String location
String[] names
VirtualServer.RegexReplacement[] values
)setLogClientConnectionFailures( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the virtual server will log client connection failures.
void setLogClientConnectionFailures(
String[] names
Boolean[] values
)setLogClientConnectionFailuresByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the virtual server will log client connection failures. This is a location specific function, any action will operate on the specified location.
void setLogClientConnectionFailuresByLocation(
String location
String[] names
Boolean[] values
)setLogEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should log each connection to a disk on the file system.
void setLogEnabled(
String[] names
Boolean[] values
)setLogEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should log each connection to a disk on the file system. This is a location specific function, any action will operate on the specified location.
void setLogEnabledByLocation(
String location
String[] names
Boolean[] values
)setLogFilename( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the name of the file used to store request logs, for each of the named virtual servers.
void setLogFilename(
String[] names
String[] values
)setLogFilenameByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the name of the file used to store request logs, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setLogFilenameByLocation(
String location
String[] names
String[] values
)setLogFormat( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the log file format for each of the named virtual servers.
void setLogFormat(
String[] names
String[] values
)setLogFormatByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the log file format for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setLogFormatByLocation(
String location
String[] names
String[] values
)setLogSSLFailures( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the virtual server will log ssl failures.
void setLogSSLFailures(
String[] names
Boolean[] values
)setLogSSLFailuresByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the virtual server will log ssl failures. This is a location specific function, any action will operate on the specified location.
void setLogSSLFailuresByLocation(
String location
String[] names
Boolean[] values
)setLogSSLResumptionFailures( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the virtual server will log messages when attempts to resume SSL sessions fail.
void setLogSSLResumptionFailures(
String[] names
Boolean[] values
)setLogSSLResumptionFailuresByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the virtual server will log messages when attempts to resume SSL sessions fail. This is a location specific function, any action will operate on the specified location.
void setLogSSLResumptionFailuresByLocation(
String location
String[] names
Boolean[] values
)setLogSaveAll( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to log all connections by default, or log no connections by default.
void setLogSaveAll(
String[] names
Boolean[] values
)setLogSaveAllByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to log all connections by default, or log no connections by default. This is a location specific function, any action will operate on the specified location.
void setLogSaveAllByLocation(
String location
String[] names
Boolean[] values
)setLogServerConnectionFailures( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the virtual server will log server connection failures.
void setLogServerConnectionFailures(
String[] names
Boolean[] values
)setLogServerConnectionFailuresByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the virtual server will log server connection failures. This is a location specific function, any action will operate on the specified location.
void setLogServerConnectionFailuresByLocation(
String location
String[] names
Boolean[] values
)setLogSessionPersistenceVerbose( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the virtual server will log session persistence events.
void setLogSessionPersistenceVerbose(
String[] names
Boolean[] values
)setLogSessionPersistenceVerboseByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the virtual server will log session persistence events. This is a location specific function, any action will operate on the specified location.
void setLogSessionPersistenceVerboseByLocation(
String location
String[] names
Boolean[] values
)setMIMEAutoDetect( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should auto-detect MIME types if the server does not provide them.
void setMIMEAutoDetect(
String[] names
Boolean[] values
)setMIMEAutoDetectByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should auto-detect MIME types if the server does not provide them. This is a location specific function, any action will operate on the specified location.
void setMIMEAutoDetectByLocation(
String location
String[] names
Boolean[] values
)setMIMEDefaultType( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the MIME type that the server uses as its 'default', for each of the named virtual servers. Responses with this mime type will be auto-corrected by the virtual server if this setting is enabled.
void setMIMEDefaultType(
String[] names
String[] values
)setMIMEDefaultTypeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the MIME type that the server uses as its 'default', for each of the named virtual servers. Responses with this mime type will be auto-corrected by the virtual server if this setting is enabled. This is a location specific function, any action will operate on the specified location.
void setMIMEDefaultTypeByLocation(
String location
String[] names
String[] values
)setMaxClientBuffer( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the amount of memory used to store data sent by the client, in bytes, for each of the named virtual servers.
void setMaxClientBuffer(
String[] names
Unsigned Integer[] values
)setMaxClientBufferByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the amount of memory used to store data sent by the client, in bytes, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setMaxClientBufferByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxConcurrentConnections( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set sets the maximum number of concurrent TCP connections this virtual server will accept. A value of 0 will allow unlimited concurrent TCP connections to this virtual server.
void setMaxConcurrentConnections(
String[] names
Unsigned Integer[] values
)setMaxConcurrentConnectionsByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set sets the maximum number of concurrent TCP connections this virtual server will accept. A value of 0 will allow unlimited concurrent TCP connections to this virtual server. This is a location specific function, any action will operate on the specified location.
void setMaxConcurrentConnectionsByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxServerBuffer( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the amount of memory used to store data returned by the server, in bytes, for each of the named virtual servers.
void setMaxServerBuffer(
String[] names
Unsigned Integer[] values
)setMaxServerBufferByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the amount of memory used to store data returned by the server, in bytes, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setMaxServerBufferByLocation(
String location
String[] names
Unsigned Integer[] values
)setMaxTransactionDuration( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the total amount of time a transaction can take, zero means forever.
void setMaxTransactionDuration(
String[] names
Unsigned Integer[] values
)setMaxTransactionDurationByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the total amount of time a transaction can take, zero means forever. This is a location specific function, any action will operate on the specified location.
void setMaxTransactionDurationByLocation(
String location
String[] names
Unsigned Integer[] values
)setNote( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the note for each of the named virtual servers.
void setNote(
String[] names
String[] values
)setPort( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the port that each of the named virtual servers listens on for incoming connections.
void setPort(
String[] names
Unsigned Integer[] values
)setPortByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the port that each of the named virtual servers listens on for incoming connections. This is a location specific function, any action will operate on the specified location.
void setPortByLocation(
String location
String[] names
Unsigned Integer[] values
)setProtection( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Service Protection Settings that are used to protect each of the named virtual servers.
void setProtection(
String[] names
String[] values
)setProtectionByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Service Protection Settings that are used to protect each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setProtectionByLocation(
String location
String[] names
String[] values
)setProtocol( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the protocol that each of the named virtual servers uses.
void setProtocol(
String[] names
VirtualServer.Protocol[] values
)setProxyClose( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should send a FIN packet on to the back-end server when it is received from the client. The alternative is to close the connection to the client immediately. If the traffic manager is responding to the request itself, enabling this setting will cause the traffic manager to continue writing the response even after it has received a FIN from the client.
void setProxyClose(
String[] names
Boolean[] values
)setProxyCloseByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should send a FIN packet on to the back-end server when it is received from the client. The alternative is to close the connection to the client immediately. If the traffic manager is responding to the request itself, enabling this setting will cause the traffic manager to continue writing the response even after it has received a FIN from the client. This is a location specific function, any action will operate on the specified location.
void setProxyCloseByLocation(
String location
String[] names
Boolean[] values
)setProxyProtocol( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set expect connections to the traffic manager to be prefixed with a PROXY protocol header.
void setProxyProtocol(
String[] names
Boolean[] values
)setProxyProtocolByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set expect connections to the traffic manager to be prefixed with a PROXY protocol header. This is a location specific function, any action will operate on the specified location.
void setProxyProtocolByLocation(
String location
String[] names
Boolean[] values
)setRTSPPortRange( names, range ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the port range used for RTSP streaming data connections for each of the named virtual servers.
void setRTSPPortRange(
String[] names
VirtualServer.PortRange[] range
)setRTSPPortRangeByLocation( location, names, range ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the port range used for RTSP streaming data connections for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setRTSPPortRangeByLocation(
String location
String[] names
VirtualServer.PortRange[] range
)setRTSPStreamingTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time, in seconds, after which data-streams associated with RTSP connections timeout if no data is transmitted.
void setRTSPStreamingTimeout(
String[] names
Unsigned Integer[] values
)setRTSPStreamingTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time, in seconds, after which data-streams associated with RTSP connections timeout if no data is transmitted. This is a location specific function, any action will operate on the specified location.
void setRTSPStreamingTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setRecentConnsEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether or not any connections handled by this virtual server should be shown on the Connections page.
void setRecentConnsEnabled(
String[] names
Boolean[] values
)setRecentConnsEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether or not any connections handled by this virtual server should be shown on the Connections page. This is a location specific function, any action will operate on the specified location.
void setRecentConnsEnabledByLocation(
String location
String[] names
Boolean[] values
)setRecentConnsSaveAll( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether or not all connections handled by this virtual server should be shown on the Connections page.
void setRecentConnsSaveAll(
String[] names
Boolean[] values
)setRecentConnsSaveAllByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether or not all connections handled by this virtual server should be shown on the Connections page. This is a location specific function, any action will operate on the specified location.
void setRecentConnsSaveAllByLocation(
String location
String[] names
Boolean[] values
)setRequestSyslogEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should log each connection to a remote syslog server.
void setRequestSyslogEnabled(
String[] names
Boolean[] values
)setRequestSyslogEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should log each connection to a remote syslog server. This is a location specific function, any action will operate on the specified location.
void setRequestSyslogEnabledByLocation(
String location
String[] names
Boolean[] values
)setRequestSyslogFormat( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the remote log line format for each of the named virtual servers.
void setRequestSyslogFormat(
String[] names
String[] values
)setRequestSyslogFormatByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the remote log line format for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setRequestSyslogFormatByLocation(
String location
String[] names
String[] values
)setRequestSyslogIPEndpoint( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the remote syslog endpoint for each of the named virtual servers
void setRequestSyslogIPEndpoint(
String[] names
String[] values
)setRequestSyslogIPEndpointByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the remote syslog endpoint for each of the named virtual servers This is a location specific function, any action will operate on the specified location.
void setRequestSyslogIPEndpointByLocation(
String location
String[] names
String[] values
)setRequestSyslogMessageLenLimit( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set syslog message length limit.
void setRequestSyslogMessageLenLimit(
String[] names
Unsigned Integer[] values
)setRequestSyslogMessageLenLimitByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set syslog message length limit. This is a location specific function, any action will operate on the specified location.
void setRequestSyslogMessageLenLimitByLocation(
String location
String[] names
Unsigned Integer[] values
)setRequestTracingEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to record a detailed list of processing history for each request.
void setRequestTracingEnabled(
String[] names
Boolean[] values
)setRequestTracingEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to record a detailed list of processing history for each request. This is a location specific function, any action will operate on the specified location.
void setRequestTracingEnabledByLocation(
String location
String[] names
Boolean[] values
)setRequestTracingIO( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to record a detailed list of every IO event in the processing history for each request.
void setRequestTracingIO(
String[] names
Boolean[] values
)setRequestTracingIOByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to record a detailed list of every IO event in the processing history for each request. This is a location specific function, any action will operate on the specified location.
void setRequestTracingIOByLocation(
String location
String[] names
Boolean[] values
)setResponseRules( names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the rules that are run on server responses for each of the named virtual servers.
void setResponseRules(
String[] names
VirtualServer.Rule[][] rules
)setResponseRulesByLocation( location, names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the rules that are run on server responses for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setResponseRulesByLocation(
String location
String[] names
VirtualServer.Rule[][] rules
)setRewriteSIPURI( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the Request-URI of SIP requests will be replaced with the selected back-end node's address.
void setRewriteSIPURI(
String[] names
Boolean[] values
)setRewriteSIPURIByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the Request-URI of SIP requests will be replaced with the selected back-end node's address. This is a location specific function, any action will operate on the specified location.
void setRewriteSIPURIByLocation(
String location
String[] names
Boolean[] values
)setRules( names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the rules that are run on client requests for each of the named virtual servers.
void setRules(
String[] names
VirtualServer.Rule[][] rules
)setRulesByLocation( location, names, rules ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the rules that are run on client requests for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setRulesByLocation(
String location
String[] names
VirtualServer.Rule[][] rules
)setSIPDangerousRequestMode( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set what should be done with requests that contain body data and should be routed to an external IP.
void setSIPDangerousRequestMode(
String[] names
VirtualServer.SIPDangerousRequestMode[] values
)setSIPDangerousRequestModeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set what should be done with requests that contain body data and should be routed to an external IP. This is a location specific function, any action will operate on the specified location.
void setSIPDangerousRequestModeByLocation(
String location
String[] names
VirtualServer.SIPDangerousRequestMode[] values
)setSIPFollowRoute( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to follow routing information in SIP requests.
void setSIPFollowRoute(
String[] names
Boolean[] values
)setSIPFollowRouteByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to follow routing information in SIP requests. This is a location specific function, any action will operate on the specified location.
void setSIPFollowRouteByLocation(
String location
String[] names
Boolean[] values
)setSIPMaxConnectionMemory( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set maximum memory per connection.
void setSIPMaxConnectionMemory(
String[] names
Unsigned Integer[] values
)setSIPMaxConnectionMemoryByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set maximum memory per connection. This is a location specific function, any action will operate on the specified location.
void setSIPMaxConnectionMemoryByLocation(
String location
String[] names
Unsigned Integer[] values
)setSIPMode( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set which mode of operation the SIP virtual server should run in.
void setSIPMode(
String[] names
VirtualServer.SIPMode[] values
)setSIPModeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set which mode of operation the SIP virtual server should run in. This is a location specific function, any action will operate on the specified location.
void setSIPModeByLocation(
String location
String[] names
VirtualServer.SIPMode[] values
)setSIPPortRange( names, range ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the port range used for SIP data connections for each of the named virtual servers. This setting is only used when the SIP virtual server is using 'Full Gateway' mode.
void setSIPPortRange(
String[] names
VirtualServer.PortRange[] range
)setSIPPortRangeByLocation( location, names, range ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the port range used for SIP data connections for each of the named virtual servers. This setting is only used when the SIP virtual server is using 'Full Gateway' mode. This is a location specific function, any action will operate on the specified location.
void setSIPPortRangeByLocation(
String location
String[] names
VirtualServer.PortRange[] range
)setSIPStreamingTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time, in seconds, after which a UDP stream will timeout if it has not seen any data.
void setSIPStreamingTimeout(
String[] names
Unsigned Integer[] values
)setSIPStreamingTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time, in seconds, after which a UDP stream will timeout if it has not seen any data. This is a location specific function, any action will operate on the specified location.
void setSIPStreamingTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setSIPTimeoutMessages( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set send a timed out response to the client and CANCEL request to the server when a transaction times out.
void setSIPTimeoutMessages(
String[] names
Boolean[] values
)setSIPTimeoutMessagesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set send a timed out response to the client and CANCEL request to the server when a transaction times out. This is a location specific function, any action will operate on the specified location.
void setSIPTimeoutMessagesByLocation(
String location
String[] names
Boolean[] values
)setSIPUDPAssociateBySource( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether all datagrams in a SIP transaction must have been received from the same source address and port.
void setSIPUDPAssociateBySource(
String[] names
Boolean[] values
)setSIPUDPAssociateBySourceByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether all datagrams in a SIP transaction must have been received from the same source address and port. This is a location specific function, any action will operate on the specified location.
void setSIPUDPAssociateBySourceByLocation(
String location
String[] names
Boolean[] values
)setSSLCertificate( names, certs ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Set the name of the default SSL Certificate that is used for SSL decryption for each of the named virtual servers. This is the name of an item in the SSL Certificates Catalog. You must call this function to set an SSL Certificate before turning on SSL Decryption.
void setSSLCertificate(
String[] names
String[] certs
)setSSLCertificateByLocation( location, names, certs ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Set the name of the default SSL Certificate that is used for SSL decryption for each of the named virtual servers. This is the name of an item in the SSL Certificates Catalog. You must call this function to set an SSL Certificate before turning on SSL Decryption. This is a location specific function, any action will operate on the specified location.
void setSSLCertificateByLocation(
String location
String[] names
String[] certs
)setSSLCertificates( names, certs ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Set the name of the SSL certificates that are used for SSL decryption for each of the named virtual servers. This is the name of an item in the SSL Certificates Catalog. You must call this function to set SSL Certificates before turning on SSL Decryption.
void setSSLCertificates(
String[] names
String[][] certs
)setSSLCertificatesByLocation( location, names, certs ) throws ObjectDoesNotExist, DeploymentError, InvalidInput, InvalidOperation
Set the name of the SSL certificates that are used for SSL decryption for each of the named virtual servers. This is the name of an item in the SSL Certificates Catalog. You must call this function to set SSL Certificates before turning on SSL Decryption. This is a location specific function, any action will operate on the specified location.
void setSSLCertificatesByLocation(
String location
String[] names
String[][] certs
)setSSLCipherSuites( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the SSL/TLS cipher suites allowed for connections to this virtual server
void setSSLCipherSuites(
String[] names
String[] values
)setSSLCipherSuitesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the SSL/TLS cipher suites allowed for connections to this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLCipherSuitesByLocation(
String location
String[] names
String[] values
)setSSLCiphers( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is deprecated, and has been replaced with VirtualServer.setSSLCipherSuites
void setSSLCiphers(
String[] names
String[] values
)setSSLCiphersByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is deprecated, and has been replaced with VirtualServer.setSSLCipherSuites This is a location specific function, any action will operate on the specified location.
void setSSLCiphersByLocation(
String location
String[] names
String[] values
)setSSLClientCertificateAuthorities( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the certificate authorities that are trusted for validating client certificates, for each of the named virtual servers.
void setSSLClientCertificateAuthorities(
String[] names
String[][] values
)setSSLClientCertificateAuthoritiesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the certificate authorities that are trusted for validating client certificates, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setSSLClientCertificateAuthoritiesByLocation(
String location
String[] names
String[][] values
)setSSLClientCertificateHeaders( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should add HTTP headers to each request to show the data in the client certificate.
void setSSLClientCertificateHeaders(
String[] names
VirtualServer.SSLClientCertificateHeaders[] values
)setSSLClientCertificateHeadersByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should add HTTP headers to each request to show the data in the client certificate. This is a location specific function, any action will operate on the specified location.
void setSSLClientCertificateHeadersByLocation(
String location
String[] names
VirtualServer.SSLClientCertificateHeaders[] values
)setSSLDecrypt( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Sets whether each of the named virtual servers should decrypt SSL traffic. This function will error unless an SSL Certificate has previously been set using setSSLCertificate.
void setSSLDecrypt(
String[] names
Boolean[] values
)setSSLDecryptByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Sets whether each of the named virtual servers should decrypt SSL traffic. This function will error unless an SSL Certificate has previously been set using setSSLCertificate. This is a location specific function, any action will operate on the specified location.
void setSSLDecryptByLocation(
String location
String[] names
Boolean[] values
)setSSLEllipticCurves( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the elliptic curve preference list for SSL connections to this virtual server
void setSSLEllipticCurves(
String[] names
String[] values
)setSSLEllipticCurvesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the elliptic curve preference list for SSL connections to this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLEllipticCurvesByLocation(
String location
String[] names
String[] values
)setSSLExpectStartTLS( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should upgrade SMTP connections to SSL using the STARTTLS command.
void setSSLExpectStartTLS(
String[] names
Boolean[] values
)setSSLExpectStartTLSByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should upgrade SMTP connections to SSL using the STARTTLS command. This is a location specific function, any action will operate on the specified location.
void setSSLExpectStartTLSByLocation(
String location
String[] names
Boolean[] values
)setSSLHeaders( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should add HTTP headers to each request to show SSL connection parameters.
void setSSLHeaders(
String[] names
Boolean[] values
)setSSLHeadersByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should add HTTP headers to each request to show SSL connection parameters. This is a location specific function, any action will operate on the specified location.
void setSSLHeadersByLocation(
String location
String[] names
Boolean[] values
)setSSLHonorFallbackSCSV( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether Fallback SCSV is honored by this virtual server
void setSSLHonorFallbackSCSV(
String[] names
VirtualServer.SSLHonorFallbackSCSV[] values
)setSSLHonorFallbackSCSVByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether Fallback SCSV is honored by this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLHonorFallbackSCSVByLocation(
String location
String[] names
VirtualServer.SSLHonorFallbackSCSV[] values
)setSSLLogEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete. SSL logging is now done if LogConnectionFailures is enabled. Use VirtualServer.getLogConnectionFailures and VirtualServer.getLogConnection failures to control this configuration.
void setSSLLogEnabled(
String[] names
Boolean[] values
)setSSLNeverExpiringClientCertificateAuthorities( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the CAs for which any client certificate they validate is considered valid even if the client certificate's expiration date has passed.
void setSSLNeverExpiringClientCertificateAuthorities(
String[] names
String[][] values
)setSSLNeverExpiringClientCertificateAuthoritiesByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the CAs for which any client certificate they validate is considered valid even if the client certificate's expiration date has passed. This is a location specific function, any action will operate on the specified location.
void setSSLNeverExpiringClientCertificateAuthoritiesByLocation(
String location
String[] names
String[][] values
)setSSLNeverExpiringClientCertificateAuthoritiesDepth( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the number of certificates in a certificate chain beyond those listed as NeverExpiringClientCertificateAuthorities whose certificate expiry will not be checked.
void setSSLNeverExpiringClientCertificateAuthoritiesDepth(
String[] names
Unsigned Integer[] values
)setSSLNeverExpiringClientCertificateAuthoritiesDepthByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the number of certificates in a certificate chain beyond those listed as NeverExpiringClientCertificateAuthorities whose certificate expiry will not be checked. This is a location specific function, any action will operate on the specified location.
void setSSLNeverExpiringClientCertificateAuthoritiesDepthByLocation(
String location
String[] names
Unsigned Integer[] values
)setSSLOCSPDefaults( names, ssl_ocsp_issuers ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the default OCSP responder settings for all client certificates.
void setSSLOCSPDefaults(
String[] names
VirtualServer.SSLOCSPIssuer[] ssl_ocsp_issuers
)setSSLOCSPDefaultsByLocation( location, names, ssl_ocsp_issuers ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the default OCSP responder settings for all client certificates. This is a location specific function, any action will operate on the specified location.
void setSSLOCSPDefaultsByLocation(
String location
String[] names
VirtualServer.SSLOCSPIssuer[] ssl_ocsp_issuers
)setSSLOCSPIssuers( names, ssl_ocsp_issuers ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Sets a list of mappings between Certificate Authorities and OCSP responder settings. Certificates issued by these authorities will be verified with OCSP using these settings.
void setSSLOCSPIssuers(
String[] names
VirtualServer.SSLOCSPIssuer[][] ssl_ocsp_issuers
)setSSLOCSPIssuersByLocation( location, names, ssl_ocsp_issuers ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Sets a list of mappings between Certificate Authorities and OCSP responder settings. Certificates issued by these authorities will be verified with OCSP using these settings. This is a location specific function, any action will operate on the specified location.
void setSSLOCSPIssuersByLocation(
String location
String[] names
VirtualServer.SSLOCSPIssuer[][] ssl_ocsp_issuers
)setSSLOCSPMaxResponseAge( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the number of seconds for which an OCSP response is considered valid if it has not yet exceeded the time specified in the 'nextUpdate' field
void setSSLOCSPMaxResponseAge(
String[] names
Unsigned Integer[] values
)setSSLOCSPMaxResponseAgeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the number of seconds for which an OCSP response is considered valid if it has not yet exceeded the time specified in the 'nextUpdate' field This is a location specific function, any action will operate on the specified location.
void setSSLOCSPMaxResponseAgeByLocation(
String location
String[] names
Unsigned Integer[] values
)setSSLOCSPStapling( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the traffic manager is allowed to provide OCSP responses for certificates as part of the handshake, if the client sends a TLS status_request extension in the ClientHello, and OCSP URIs are present in certificates used by this virtual server.
void setSSLOCSPStapling(
String[] names
Boolean[] values
)setSSLOCSPStaplingByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the traffic manager is allowed to provide OCSP responses for certificates as part of the handshake, if the client sends a TLS status_request extension in the ClientHello, and OCSP URIs are present in certificates used by this virtual server. This is a location specific function, any action will operate on the specified location.
void setSSLOCSPStaplingByLocation(
String location
String[] names
Boolean[] values
)setSSLOCSPTimeTolerance( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the number of seconds outside the permitted range for which the 'thisUpdate' and 'nextUpdate' fields of an OCSP response are still considered valid
void setSSLOCSPTimeTolerance(
String[] names
Unsigned Integer[] values
)setSSLOCSPTimeToleranceByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the number of seconds outside the permitted range for which the 'thisUpdate' and 'nextUpdate' fields of an OCSP response are still considered valid This is a location specific function, any action will operate on the specified location.
void setSSLOCSPTimeToleranceByLocation(
String location
String[] names
Unsigned Integer[] values
)setSSLOCSPTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the number of seconds after which OCSP requests will be timed out
void setSSLOCSPTimeout(
String[] names
Unsigned Integer[] values
)setSSLOCSPTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the number of seconds after which OCSP requests will be timed out This is a location specific function, any action will operate on the specified location.
void setSSLOCSPTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setSSLPreferSSLv3( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now deprecated.
void setSSLPreferSSLv3(
String[] names
Boolean[] values
)setSSLPreferSSLv3ByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now deprecated. This is a location specific function, any action will operate on the specified location.
void setSSLPreferSSLv3ByLocation(
String location
String[] names
Boolean[] values
)setSSLRequestClientCertMode( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should request (or require) an identifying certificate from each client.
void setSSLRequestClientCertMode(
String[] names
VirtualServer.SSLRequestClientCertMode[] values
)setSSLRequestClientCertModeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should request (or require) an identifying certificate from each client. This is a location specific function, any action will operate on the specified location.
void setSSLRequestClientCertModeByLocation(
String location
String[] names
VirtualServer.SSLRequestClientCertMode[] values
)setSSLSendCloseAlerts( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should send a close alert when initiating SSL socket disconnections.
void setSSLSendCloseAlerts(
String[] names
Boolean[] values
)setSSLSendCloseAlertsByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should send a close alert when initiating SSL socket disconnections. This is a location specific function, any action will operate on the specified location.
void setSSLSendCloseAlertsByLocation(
String location
String[] names
Boolean[] values
)setSSLSessionCacheEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether use of the session cache is enabled for this virtual server
void setSSLSessionCacheEnabled(
String[] names
VirtualServer.SSLSessionCacheEnabled[] values
)setSSLSessionCacheEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether use of the session cache is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLSessionCacheEnabledByLocation(
String location
String[] names
VirtualServer.SSLSessionCacheEnabled[] values
)setSSLSessionTicketsEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether use of session tickets is enabled for this virtual server
void setSSLSessionTicketsEnabled(
String[] names
VirtualServer.SSLSessionTicketsEnabled[] values
)setSSLSessionTicketsEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether use of session tickets is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLSessionTicketsEnabledByLocation(
String location
String[] names
VirtualServer.SSLSessionTicketsEnabled[] values
)setSSLSignatureAlgorithms( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the SSL signature algorithms preference list for SSL connections to this virtual server
void setSSLSignatureAlgorithms(
String[] names
String[] values
)setSSLSignatureAlgorithmsByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the SSL signature algorithms preference list for SSL connections to this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLSignatureAlgorithmsByLocation(
String location
String[] names
String[] values
)setSSLSupportSSL2( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now deprecated.
void setSSLSupportSSL2(
String[] names
VirtualServer.SSLSupportSSL2[] values
)setSSLSupportSSL2ByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now deprecated. This is a location specific function, any action will operate on the specified location.
void setSSLSupportSSL2ByLocation(
String location
String[] names
VirtualServer.SSLSupportSSL2[] values
)setSSLSupportSSL3( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether SSLv3 is enabled for this virtual server
void setSSLSupportSSL3(
String[] names
VirtualServer.SSLSupportSSL3[] values
)setSSLSupportSSL3ByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether SSLv3 is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLSupportSSL3ByLocation(
String location
String[] names
VirtualServer.SSLSupportSSL3[] values
)setSSLSupportTLS1( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether TLSv1.0 is enabled for this virtual server
void setSSLSupportTLS1(
String[] names
VirtualServer.SSLSupportTLS1[] values
)setSSLSupportTLS11( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether TLSv1.1 is enabled for this virtual server
void setSSLSupportTLS11(
String[] names
VirtualServer.SSLSupportTLS11[] values
)setSSLSupportTLS11ByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether TLSv1.1 is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLSupportTLS11ByLocation(
String location
String[] names
VirtualServer.SSLSupportTLS11[] values
)setSSLSupportTLS12( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether TLSv1.2 is enabled for this virtual server
void setSSLSupportTLS12(
String[] names
VirtualServer.SSLSupportTLS12[] values
)setSSLSupportTLS12ByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether TLSv1.2 is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLSupportTLS12ByLocation(
String location
String[] names
VirtualServer.SSLSupportTLS12[] values
)setSSLSupportTLS13( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether TLSv1.3 is enabled for this virtual server
void setSSLSupportTLS13(
String[] names
VirtualServer.SSLSupportTLS13[] values
)setSSLSupportTLS13ByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether TLSv1.3 is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLSupportTLS13ByLocation(
String location
String[] names
VirtualServer.SSLSupportTLS13[] values
)setSSLSupportTLS1ByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether TLSv1.0 is enabled for this virtual server This is a location specific function, any action will operate on the specified location.
void setSSLSupportTLS1ByLocation(
String location
String[] names
VirtualServer.SSLSupportTLS1[] values
)setSSLTrustMagic( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should decode extra information on the true origin of an SSL connection. This information is prefixed onto an incoming SSL connection from another traffic manager.
void setSSLTrustMagic(
String[] names
Boolean[] values
)setSSLTrustMagicByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should decode extra information on the true origin of an SSL connection. This information is prefixed onto an incoming SSL connection from another traffic manager. This is a location specific function, any action will operate on the specified location.
void setSSLTrustMagicByLocation(
String location
String[] names
Boolean[] values
)setSSLUseOCSP( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether or not the traffic manager should use OCSP to check the revocation status of client certificates
void setSSLUseOCSP(
String[] names
Boolean[] values
)setSSLUseOCSPByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether or not the traffic manager should use OCSP to check the revocation status of client certificates This is a location specific function, any action will operate on the specified location.
void setSSLUseOCSPByLocation(
String location
String[] names
Boolean[] values
)setServerfirstBanner( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the banner that each of the named virtual servers sends to clients for server-first protocols such as POP, SMTP and IMAP.
void setServerfirstBanner(
String[] names
String[] values
)setServerfirstBannerByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the banner that each of the named virtual servers sends to clients for server-first protocols such as POP, SMTP and IMAP. This is a location specific function, any action will operate on the specified location.
void setServerfirstBannerByLocation(
String location
String[] names
String[] values
)setServiceLevelMonitoring( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Service Level Monitoring class that each of the named virtual servers uses.
void setServiceLevelMonitoring(
String[] names
String[] values
)setServiceLevelMonitoringByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Service Level Monitoring class that each of the named virtual servers uses. This is a location specific function, any action will operate on the specified location.
void setServiceLevelMonitoringByLocation(
String location
String[] names
String[] values
)setSipTransactionTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time after which an incomplete transaction should be discarded, in seconds, for each of the named virtual servers.
void setSipTransactionTimeout(
String[] names
Unsigned Integer[] values
)setSipTransactionTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time after which an incomplete transaction should be discarded, in seconds, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setSipTransactionTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setStripXForwardedProtoHeader( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set Whether or not the virtual server should strip the \ 'X-Forwarded-Proto' header from incoming requests.
void setStripXForwardedProtoHeader(
String[] names
Boolean[] values
)setStripXForwardedProtoHeaderByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set Whether or not the virtual server should strip the \ 'X-Forwarded-Proto' header from incoming requests. This is a location specific function, any action will operate on the specified location.
void setStripXForwardedProtoHeaderByLocation(
String location
String[] names
Boolean[] values
)setTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time to wait for data on an already established connection, in seconds, for each of the named virtual servers.
void setTimeout(
String[] names
Unsigned Integer[] values
)setTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time to wait for data on an already established connection, in seconds, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setTransactionExportBrief( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to export a restricted set of metadata about transactions processed by this virtual server. If enabled, more verbose information such as client and server headers and request tracing events will be omitted from the exported data.
void setTransactionExportBrief(
String[] names
Boolean[] values
)setTransactionExportBriefByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to export a restricted set of metadata about transactions processed by this virtual server. If enabled, more verbose information such as client and server headers and request tracing events will be omitted from the exported data. This is a location specific function, any action will operate on the specified location.
void setTransactionExportBriefByLocation(
String location
String[] names
Boolean[] values
)setTransactionExportEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to export metadata about transactions handled by this service to the globally configured endpoint.
void setTransactionExportEnabled(
String[] names
Boolean[] values
)setTransactionExportEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether to export metadata about transactions handled by this service to the globally configured endpoint. This is a location specific function, any action will operate on the specified location.
void setTransactionExportEnabledByLocation(
String location
String[] names
Boolean[] values
)setTransactionExportHTTPHeaderBlacklist( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the set of HTTP header names for which corresponding values should be redacted from the metadata exported by this virtual server. from transaction export.
void setTransactionExportHTTPHeaderBlacklist(
String[] names
String[][] values
)setTransactionExportHTTPHeaderBlacklistByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the set of HTTP header names for which corresponding values should be redacted from the metadata exported by this virtual server. from transaction export. This is a location specific function, any action will operate on the specified location.
void setTransactionExportHTTPHeaderBlacklistByLocation(
String location
String[] names
String[][] values
)setTransactionExportHiRes( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the transaction processing timeline included in the metadata export is recorded with a high, microsecond, resolution. If set to No, timestamps will be recorded with a resolution of milliseconds.
void setTransactionExportHiRes(
String[] names
Boolean[] values
)setTransactionExportHiResByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether the transaction processing timeline included in the metadata export is recorded with a high, microsecond, resolution. If set to No, timestamps will be recorded with a resolution of milliseconds. This is a location specific function, any action will operate on the specified location.
void setTransactionExportHiResByLocation(
String location
String[] names
Boolean[] values
)setTransparent( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether or not bound sockets should be configured for transparent proxying.
void setTransparent(
String[] names
Boolean[] values
)setTransparentByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether or not bound sockets should be configured for transparent proxying. This is a location specific function, any action will operate on the specified location.
void setTransparentByLocation(
String location
String[] names
Boolean[] values
)setUDPEndTransaction( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setUDPEndTransaction(
String[] names
VirtualServer.UDPEndTransaction[] values
)setUDPEndTransactionByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
This method is now obsolete.
void setUDPEndTransactionByLocation(
String location
String[] names
VirtualServer.UDPEndTransaction[] values
)setUDPEndpointPersistence( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should send UDP datagrams received from the same IP address and port to the same pool node if they match an existing UDP session. Sessions are defined by the protocol being handled, for example SIP datagrams are grouped based on the value of the Call-ID header.
void setUDPEndpointPersistence(
String[] names
Boolean[] values
)setUDPEndpointPersistenceByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should send UDP datagrams received from the same IP address and port to the same pool node if they match an existing UDP session. Sessions are defined by the protocol being handled, for example SIP datagrams are grouped based on the value of the Call-ID header. This is a location specific function, any action will operate on the specified location.
void setUDPEndpointPersistenceByLocation(
String location
String[] names
Boolean[] values
)setUDPRbuffSize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the socket receive buffer size
void setUDPRbuffSize(
String[] names
Unsigned Integer[] values
)setUDPRbuffSizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the socket receive buffer size This is a location specific function, any action will operate on the specified location.
void setUDPRbuffSizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setUDPResponseDatagramsExpected( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the expected number of UDP datagrams in the response, for each of the named virtual servers. For simple request/response protocols a value of '1' should be used. If set to -1, the connection will not be discarded until the udp_timeout is reached.
void setUDPResponseDatagramsExpected(
String[] names
Integer[] values
)setUDPResponseDatagramsExpectedByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the expected number of UDP datagrams in the response, for each of the named virtual servers. For simple request/response protocols a value of '1' should be used. If set to -1, the connection will not be discarded until the udp_timeout is reached. This is a location specific function, any action will operate on the specified location.
void setUDPResponseDatagramsExpectedByLocation(
String location
String[] names
Integer[] values
)setUDPTimeout( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time after which an idle UDP connection should be discarded and resources reclaimed, in seconds, for each of the named virtual servers.
void setUDPTimeout(
String[] names
Unsigned Integer[] values
)setUDPTimeoutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time after which an idle UDP connection should be discarded and resources reclaimed, in seconds, for each of the named virtual servers. This is a location specific function, any action will operate on the specified location.
void setUDPTimeoutByLocation(
String location
String[] names
Unsigned Integer[] values
)setUDPWbuffSize( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the socket send buffer size
void setUDPWbuffSize(
String[] names
Unsigned Integer[] values
)setUDPWbuffSizeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the socket send buffer size This is a location specific function, any action will operate on the specified location.
void setUDPWbuffSizeByLocation(
String location
String[] names
Unsigned Integer[] values
)setUseNagle( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether Nagle's algorithm should be used for TCP connections.
void setUseNagle(
String[] names
Boolean[] values
)setUseNagleByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether Nagle's algorithm should be used for TCP connections. This is a location specific function, any action will operate on the specified location.
void setUseNagleByLocation(
String location
String[] names
Boolean[] values
)setWebcacheControlOut( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Cache-Control header that should be sent with cached HTTP responses.
void setWebcacheControlOut(
String[] names
String[] values
)setWebcacheControlOutByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the Cache-Control header that should be sent with cached HTTP responses. This is a location specific function, any action will operate on the specified location.
void setWebcacheControlOutByLocation(
String location
String[] names
String[] values
)setWebcacheEnabled( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should attempt to cache web server responses.
void setWebcacheEnabled(
String[] names
Boolean[] values
)setWebcacheEnabledByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set whether each of the named virtual servers should attempt to cache web server responses. This is a location specific function, any action will operate on the specified location.
void setWebcacheEnabledByLocation(
String location
String[] names
Boolean[] values
)setWebcacheErrorpageTime( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time periods that each of the named virtual servers should cache error pages for.
void setWebcacheErrorpageTime(
String[] names
Unsigned Integer[] values
)setWebcacheErrorpageTimeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time periods that each of the named virtual servers should cache error pages for. This is a location specific function, any action will operate on the specified location.
void setWebcacheErrorpageTimeByLocation(
String location
String[] names
Unsigned Integer[] values
)setWebcacheRefreshTime( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time periods that each of the named virtual servers should consider re-fetching cached pages in.
void setWebcacheRefreshTime(
String[] names
Unsigned Integer[] values
)setWebcacheRefreshTimeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time periods that each of the named virtual servers should consider re-fetching cached pages in. This is a location specific function, any action will operate on the specified location.
void setWebcacheRefreshTimeByLocation(
String location
String[] names
Unsigned Integer[] values
)setWebcacheTime( names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time periods that each of the named virtual servers should cache web pages for.
void setWebcacheTime(
String[] names
Unsigned Integer[] values
)setWebcacheTimeByLocation( location, names, values ) throws InvalidInput, ObjectDoesNotExist, DeploymentError
Set the time periods that each of the named virtual servers should cache web pages for. This is a location specific function, any action will operate on the specified location.
void setWebcacheTimeByLocation(
String location
String[] names
Unsigned Integer[] values
)Structures
VirtualServer.BasicInfo
This structure contains the basic information for a virtual server. It is used when creating a server, or modifying the port, protocol or default pool of a server.
struct VirtualServer.BasicInfo {
# The port to listen for incoming connections on.
Integer port;
# The protocol that this virtual server handles.
VirtualServer.Protocol protocol;
# The default pool that traffic to this virtual server will go to.
String default_pool;
}VirtualServer.CASite
This object represents a mapping between a hostname or IP address and settings controlling a request for a client certificate. Clients sending an SNI extension containing this hostname or connecting to the CA Site's address will use these settings.
struct VirtualServer.CASite {
# The hostname or IP address that these settings apply to.
String host_or_ip;
# The certificates present in the Certificate Authorities and Certificate
# Revocation Lists catalog that will be sent in any Certificate Request
# message to the client, and then used to verify the client certificate
# received. Setting the empty list permits any client certificate received to
# be accepted.
String[] client_cas;
# Whether HTTP request headers should be used to convey information about the
# client certificate to pool nodes.
VirtualServer.SSLClientCertificateHeaders cert_headers;
# Determines whether a client certificate will be requested, and what should
# be done if such a request is ignored.
VirtualServer.SSLRequestClientCertMode request_cert;
}VirtualServer.FTPPortRange
This structure contains the range of ports that FTP data connections use.
struct VirtualServer.FTPPortRange {
# The lower bound of the port range for FTP data connections.
Integer low;
# The upper bound of the port range for FTP data connections.
Integer high;
}VirtualServer.PortRange
This structure contains the range of ports.
struct VirtualServer.PortRange {
# The lower bound of the port range.
Integer low;
# The upper bound of the port range.
Integer high;
}VirtualServer.RegexReplacement
This structure contains a regex and a replacement string.
struct VirtualServer.RegexReplacement {
# The regular expression used to match against.
String regex;
# The replacement string if the regular expression matches. Parameters $1-$9
# can be used to represent bracketed parts of the regular expression.
String replacement;
}VirtualServer.Rule
This structure contains the information on how a rule is assigned to a virtual server.
struct VirtualServer.Rule {
# The name of the rule.
String name;
# Whether the rule is enabled or not.
Boolean enabled;
# Whether the rule runs on every request/response, or just the first
VirtualServer.RuleRunFlag run_frequency;
}VirtualServer.SSLOCSPIssuer
This object represents a mapping between a Certificate Authority (this is the name of an item in the Certificate Authorities Catalog) and configuration for an OCSP responder. Certificates issued by the Certificate Authority will use these OCSP responder settings.
struct VirtualServer.SSLOCSPIssuer {
# The Certificate Authority for which these settings apply. This is the name
# of an item in the Certificate Authorities Catalog.
String ca;
# The URL of the OCSP responder that should be used to check the revocation
# status of certificates issued by the Certificate Authority.
String url;
# Is OCSP required for certificates signed by this CA?
VirtualServer.SSLOCSPCheck required;
# If set to true the Authority Information Access X509 extension will be used
# to determine the OCSP server's URL
Boolean aia;
# Should an OCSP nonce be added to each request to protect against replay
# attacks. Not all OCSP servers support nonces.
VirtualServer.SSLOCSPNonce nonce;
# Should we sign OCSP requests?
VirtualServer.SSLOCSPSignMode sign_mode;
# The key pair used to sign OCSP requests. If not set OCSP requests will not
# be signed. Must be an entry in the SSL Certificates Catalog.
String signer;
# The expected certificate that the OCSP responder should provide. Must be in
# the Certificate Authority catalog, or be empty (meaning the issuer
# certificate), or be exactly "_SIGNED_BY_ISSUER_" (which will accept either
# the issuer or one that is signed by it and has id-kp-OCSPSigning in
# extendedKeyUsage and has id-pkix-ocsp-nocheck).
String responder_cert;
}VirtualServer.SSLSite
This object represents a mapping between a destination address and an SSL certificate (this is the name of an item in the SSL Certificates Catalog). Clients connecting to the SSL Site's address will be sent the associated certificate.
struct VirtualServer.SSLSite {
# The destination address that this site handles.
String dest_address;
# The certificate that will be sent when clients connect to the destination
# address. This is a certificate name from the SSL Certificates Catalog.
String certificate;
}VirtualServer.SSLSiteAlt
This object is an extension to SSLSite and provides support for multiple certificates per SSL site.
struct VirtualServer.SSLSiteAlt {
# The destination address that this site handles.
String dest_address;
# The certificate that will be sent when clients connect to the destination
# address. This is a certificate name from the SSL Certificates Catalog.
String certificate;
# The extra SSL certificates.
String[] alt_certificates;
}Enumerations
VirtualServer.AuthSamlNameIdFormat
enum VirtualServer.AuthSamlNameIdFormat {
# none
none,
# unspecified
unspecified,
# emailAddress
emailAddress
}VirtualServer.AuthType
enum VirtualServer.AuthType {
# None
none,
# SAML Service Provider
saml_sp
}VirtualServer.CompressionETagRewrite
enum VirtualServer.CompressionETagRewrite {
# Leave the ETag unchanged
ignore,
# Delete the ETag header
delete,
# Change the ETag header to specify a weak match
weaken,
# Wrap the ETag, and attempt to unwrap safe conditional requests
wrap
}VirtualServer.CookieDomainRewriteMode
enum VirtualServer.CookieDomainRewriteMode {
# Do not rewrite the domain
no_rewrite,
# Rewrite the domain to the host header of the request
set_to_request,
# Rewrite the domain to the named domain value
set_to_named
}VirtualServer.CookieSecureFlagRewriteMode
enum VirtualServer.CookieSecureFlagRewriteMode {
# Do not modify the 'secure' tag
no_modify,
# Set the 'secure' tag
set_secure,
# Unset the 'secure' tag
unset_secure
}VirtualServer.DNSRecordsetOrder
enum VirtualServer.DNSRecordsetOrder {
# Fixed
fixed,
# Cyclic
cyclic
}VirtualServer.HttpChunkOverheadForwarding
enum VirtualServer.HttpChunkOverheadForwarding {
# lazy
lazy,
# eager
eager
}VirtualServer.LocationDefaultRewriteMode
enum VirtualServer.LocationDefaultRewriteMode {
# Nothing;
never,
# Rewrite the hostname to the request's "Host" header, and rewrite the
# protocol and port if necessary;
always,
# Do not rewrite the hostname. Rewrite the protocol and port if the hostname
# matches the request's "Host" header.
if_host_matches
}VirtualServer.Protocol
enum VirtualServer.Protocol {
# HTTP
http,
# FTP
ftp,
# IMAPv2
imapv2,
# IMAPv3
imapv3,
# IMAPv4
imapv4,
# POP3
pop3,
# SMTP
smtp,
# LDAP
ldap,
# Telnet
telnet,
# SSL
ssl,
# SSL (HTTPS)
https,
# SSL (IMAPS)
imaps,
# SSL (POP3S)
pop3s,
# SSL (LDAPS)
ldaps,
# UDP - Streaming
udpstreaming,
# UDP
udp,
# DNS (UDP)
dns,
# DNS (TCP)
dns_tcp,
# SIP (UDP)
sipudp,
# SIP (TCP)
siptcp,
# RTSP
rtsp,
# Generic server first
server_first,
# Generic client first
client_first,
# Generic streaming
stream
}VirtualServer.RuleRunFlag
This enumeration defines the run flags for a particular rule.
enum VirtualServer.RuleRunFlag {
# Run on every request or response.
run_every,
# Run only on the first request or response.
only_first
}VirtualServer.SIPDangerousRequestMode
enum VirtualServer.SIPDangerousRequestMode {
# Send the request to a back-end node
node,
# Send a 403 Forbidden response to the client
forbid,
# Forward the request to its target URI (dangerous)
forward
}VirtualServer.SIPMode
enum VirtualServer.SIPMode {
# SIP Routing
route,
# SIP Gateway
sipgw,
# Full Gateway
fullgw
}VirtualServer.SSLClientCertificateHeaders
enum VirtualServer.SSLClientCertificateHeaders {
# No data
none,
# Certificate fields
simple,
# Certificate fields and certificate text
all
}VirtualServer.SSLHonorFallbackSCSV
enum VirtualServer.SSLHonorFallbackSCSV {
# Use the global setting for Fallback SCSV
use_default,
# Enable Fallback SCSV
enabled,
# Disable Fallback SCSV
disabled
}VirtualServer.SSLOCSPCheck
Different modes of OCSP checking for an issuer.
enum VirtualServer.SSLOCSPCheck {
# Do not perform an OCSP check
none,
# If an OCSP URL can be determined, perform an OCSP check.
optional,
# If an OCSP URL can be determined, perform an OCSP check. If not reject the
# connection.
strict
}VirtualServer.SSLOCSPNonce
Should we include nonces in requests and how strict should we be when validating the response
enum VirtualServer.SSLOCSPNonce {
# Do not use the nonce extension in OCSP requests, ignore any nonces in the
# response.
off,
# Use the nonce extension in requests. If the response contains a nonce
# validate it is correct.
on,
# Use the nonce extension in requests. The response must contain the correct
# nonce, otherwise it is rejected.
strict
}VirtualServer.SSLOCSPSignMode
The diferent modes for OCSP request signing
enum VirtualServer.SSLOCSPSignMode {
# Do not sign OCSP requests
none,
# Use default OCSP settings for signing requests
use_default,
# Use a specific catalog certificate to sign requests
sign
}VirtualServer.SSLRequestClientCertMode
enum VirtualServer.SSLRequestClientCertMode {
# Do not request a client certificate
dont_request,
# Request, but do not require a client certificate
request,
# Require a client certificate
require
}VirtualServer.SSLSessionCacheEnabled
enum VirtualServer.SSLSessionCacheEnabled {
# Use the global setting for use of the session cache
use_default,
# Enable use of the session cache
enabled,
# Disable use of the session cache
disabled
}VirtualServer.SSLSessionTicketsEnabled
enum VirtualServer.SSLSessionTicketsEnabled {
# Use the global setting for use of session tickets
use_default,
# Enable use of the session tickets
enabled,
# Disable use of the session tickets
disabled
}VirtualServer.SSLSupportSSL2
enum VirtualServer.SSLSupportSSL2 {
# Use the global setting for SSLv2
use_default,
# Enable SSLv2 (not recommended)
enabled,
# Disable SSLv2
disabled
}VirtualServer.SSLSupportSSL3
enum VirtualServer.SSLSupportSSL3 {
# Use the global setting for SSLv3
use_default,
# Enable SSLv3
enabled,
# Disable SSLv3
disabled
}VirtualServer.SSLSupportTLS1
enum VirtualServer.SSLSupportTLS1 {
# Use the global setting for TLSv1.0
use_default,
# Enable TLSv1.0
enabled,
# Disable TLSv1.0
disabled
}VirtualServer.SSLSupportTLS11
enum VirtualServer.SSLSupportTLS11 {
# Use the global setting for TLSv1.1
use_default,
# Enable TLSv1.1
enabled,
# Disable TLSv1.1
disabled
}VirtualServer.SSLSupportTLS12
enum VirtualServer.SSLSupportTLS12 {
# Use the global setting for TLSv1.2
use_default,
# Enable TLSv1.2
enabled,
# Disable TLSv1.2
disabled
}VirtualServer.SSLSupportTLS13
enum VirtualServer.SSLSupportTLS13 {
# Use the global setting for TLSv1.3
use_default,
# Enable TLSv1.3
enabled,
# Disable TLSv1.3
disabled
}VirtualServer.UDPEndTransaction
enum VirtualServer.UDPEndTransaction {
# When they time out
timeout,
# After one response
one_response,
# When the number of responses matches the number of requests
match_requests
}