APIRef_tm_sys_httpdΒΆ
mgmt/tm/sys/httpd
HTTPD configuration
REST Endpoints
- Collection URI
/mgmt/tm/sys/httpd- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/sys/httpd/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
allow |
string | optional | read/write | Adds or deletes IP addresses, partial IP addresses, and IP address ranges, hostnames, partial hostnames, domain names, partial domain names, and network and netmask pairs for the HTTP clients from which the httpd daemon accepts requests. The default value is all. Warning Using the value none resets the httpd daemon to allow all HTTP clients access to the system. F5 recommends that you do not use the value none with the httpd command. | |
authName |
string | optional | read/write | Specifies the name for the authentication realm. The default value is BIG-IP. | |
authPamDashboardTimeout |
string | optional | read/write | Specifies whether browser session timeout occurs when the dashboard is running. The default value is disabled. | |
authPamIdleTimeout |
integer | optional | read/write | Specifies the seconds before GUI session timeout. | |
authPamValidateIp |
string | optional | read/write | Specifies whether the check for consistent inbound IP for the entire web session is enforced or not. | |
description |
string | optional | read/write | User defined description. | |
fastcgiTimeout |
integer | optional | read/write | Specifies the seconds before FastCGI timeout. | |
fipsCipherVersion |
integer | optional | read/write | ||
hostnameLookup |
string | optional | read/write | Specifies whether to lookup hostname or not. The default value is off. | |
include |
string | optional | read/write | Warning: Do not use this parameter without assistance from the F5 Technical Support team. The system does not validate the commands issued using the include parameter. If you use this parameter incorrectly, you put the functionality of the system at risk. | |
logLevel |
string | optional | read/write | Specifies the minimum httpd message level to include in the system log. The default value is warn. | |
maxClients |
integer | optional | read/write | Specifies the maximum number of concurrent connections to the GUI. The default value is 10. | |
redirectHttpToHttps |
string | optional | read/write | Specifies whether the system should redirect HTTP requests targeted at the configuration utility to HTTPS. The default value is disabled. | |
requestBodyMaxTimeout |
integer | optional | read/write | Specifies, in seconds, the maximum time allowed to receive all of the request body, if the request-body-min-rate option is used, in which case the timeout is extended as more data arrives. Ignored if request-body-min-rate is not used. A value of 0 means no limit. The default value is 0. | |
requestBodyMinRate |
integer | optional | read/write | Specifies, in bytes per second, the minimum average rate at which the request body must be received. The default value is 500. | |
requestBodyTimeout |
integer | optional | read/write | Specifies, in seconds, the time allowed to receive all of the request body. A value of 0 means no limit. If you use the request-body-min-rate option, this represents the initial value for the timeout, which will be extended as more data arrives. The default value is 60. | |
requestHeaderMaxTimeout |
integer | optional | read/write | Specifies, in seconds, the maximum time allowed to receive all of the request headers, if the request-header-min-rate option is used, in which case the timeout is extended as more data arrives. Ignored if request-header-min-rate is not used. A value of 0 means no limit. The default value is 40. | |
requestHeaderMinRate |
integer | optional | read/write | Specifies, in bytes per second, the minimum average rate at which the request headers must be received. The default value is 500. | |
requestHeaderTimeout |
integer | optional | read/write | Specifies, in seconds, the time allowed to receive all of the request headers. This time includes completion of the SSL handshake. A value of 0 means no limit. If you use the request-header-min-rate option, this represents the initial value for the timeout, which will be extended as more data arrives. The default value is 20. | |
sslCaCertFile |
string | optional | read/write | Specifies the name of the file that contains the Certificate Authority (CA) certificate file. The default id none. | |
sslCertchainfile |
string | optional | read/write | Specifies the name of the file that contains the SSL certificate chain. The default is none. | |
sslCertfile |
string | optional | read/write | Specifies the name of the file that contains the SSL certificate. The default value is /etc/httpd/conf/ssl.crt/server.crt. Note that the path to the file must start with /etc/httpd/conf/ssl.crt/ or /config/httpd/conf/ssl.crt/ unless the path is a relative path. If the path is a relative path, then it must start with conf/ssl.crt/. | |
sslCertkeyfile |
string | optional | read/write | Specifies the name of the file that contains the SSL certificate key. The default value is /etc/httpd/conf/ssl.key/server.key. Note that the path to the file must start with /etc/httpd/conf/ssl.key/ or /config/httpd/conf/ssl.key/ unless the path is a relative path. If the path is a relative path, then it must start with conf/ssl.key/. When you change the key file, you must also change the certificate file. In other words, the following command does not work to change the key: bigpipe httpd sslcertkeyfile <string>. Instead, you must use this command: { bigpipe httpd sslcertfile <string> sslcertkeyfile <string> }. | |
sslCiphersuite |
string | optional | read/write | Specifies the ciphers that the system uses. | |
sslInclude |
string | optional | read/write | Warning: Do not use this parameter without assistance from the F5 Technical Support team. The system does not validate the commands issued using the include parameter. If you use this parameter incorrectly, you put the functionality of the system at risk. | |
sslOcspDefaultResponder |
string | optional | read/write | Specifies the default responder URI for OCSP validation. The default is http://localhost.localdomain. The default responder value should always be preceded with http:// | |
sslOcspEnable |
string | optional | read/write | Specifies OCSP validation of the client certificate chain. The default is off. | |
sslOcspOverrideResponder |
string | optional | read/write | Specifies the force use of default responder URI for OCSP validation. The default is off. | |
sslOcspResponderTimeout |
integer | optional | read/write | Specifies the maximum allowable time in seconds for OCSP responses. The default value is 300 seconds. | |
sslOcspResponseMaxAge |
integer | optional | read/write | Specifies the maximum allowable age in seconds for OCSP responses. A value of -1 specifies that a maximum age is not enforced. The default value is -1. | |
sslOcspResponseTimeSkew |
integer | optional | read/write | Specifies the maximum allowable time skew in seconds for OCSP response validation. The default is 300 seconds. | |
sslPort |
integer | optional | read/write | ||
sslProtocol |
string | optional | read/write | The list of SSL Protocols to accept on the management console. | |
sslVerifyClient |
string | optional | read/write | Specifies if the client certificate needs to be verified for SSL session establishment. The default is none. | |
sslVerifyDepth |
integer | optional | read/write | Specifies maximum depth of CA certificates in client certificate verification. The default is 10. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.