Virtual Service

The type of the service you want to create. The enumerated values include:

• HTTP
• HTTPS
• FTP
• FTPSSL
• CUSTOM
• CUSTOMSSL
• INSTANTSSL
• REDIRECT (for Redirect service)

The internet protocol version of the service. The enumerated values include:

• ipv4
• ipv6

The name of the vsite under which the service needs to be created.

The name of the service group under which the service needs to be created.

The certificate that needs to be presented to the browser when accessing this Service.

Note: This is a required parameter

ONLY when the service is HTTPS, Instant SSL, Custom SSL or FTP SSL.

The domain name to identify and rewrite HTTP requests to HTTPS.

Note: This is a required parameter ONLY when the service is Instant SSL.

URL: /v1/virtual_services

The certificate that needs to be presented to the browser when accessing this Service.

Note: This is a required parameter ONLY when the service is HTTPS, Instant SSL, Custom SSL or FTP SSL

The domain name to identify and rewrite HTTP requests to HTTPS.

Note: This is a required parameter ONLY when the service is Instant SSL.

The status of the virtual service. The values include:

• enable
• disable

Specifies whether to log every request made to this Service or not. The values include:

• yes – to log every request made to this Service on the BASIC > Access Logs page. 
• no – to disable logging.

The time-out period in seconds for persistent connections with clients.

Description/comment for updating the parameter values.

A web firewall policy to be associated with the service.

The enumerated values include:

• default
• sharepoint
• sharepoint2013
• owa
• owa2010
• owa2013 
• oracle

The threshold for logging the error messages for the service. The enumerated values include:

• emergency - System is unusable (highest priority)
• alert - Response must be taken immediately
• critical - Critical conditions
• error - Error conditions
• warning - Warning conditions
• notice - Normal but significant condition
• information - Informational messages (on ACL configuration changes)
• debug - Debug level messages (lowest priority)

The mode to determine how the service responds to the offending traffic. The enumerated values include:

• passive - This mode allows the intrusions to be passed to the server, but logs the events. 
• active - This mode blocks the intrusions and logs the events.

The action to be performed for a set of trusted hosts accessing the service. The values include:

• allow
• passive 
• default

The trusted hosts group to which the Trusted Hosts Action needs to be applied.

Determines how, for this service, the URLs are matched to rules like URL ACLs and URL Profiles. The values include:

• yes
• no

The rate control pool status. The enumerated values include:

• on 
• off

The algorithm to be used to distribute incoming requests for the service.

The enumerated values include:

• round_robin
• weighted_round_robin 
• weighted_least_connection

The Persistence Method to be used to maintain the connection between a client and the first server that it connects to, even when the system is load balancing traffic.

The enumerated values include:

• none
• source_ip
  • source_ip_netmask
• cookie_insert
  • persistence_cookie_name
  • persistence_cookie_domain
  • persistence_cookie_path
  • cookie_age
• cookie_passive
  • persistence_cookie_name
  • persistence_cookie_domain
  • persistence_cookie_path
  • cookie_age
• http_header
  • header_name
• url_parameter 
  • parameter_name

The failover method to be used when responding to a request which is persistent, but the server that must serve the request is failed or set to "Out-of-Service".

The enumerated values include:

• load_balance - The requests to be load balanced between the "alive" servers.
• error - Sends "503 service unavailable" error message. This method is not supported for the persistence method "Source IP".

A subnet mask to make subsequent connections from clients, from the same subnet go to the same Real Server.

Note: This is required ONLY when Persistence Method is source_ip.

The name of the cookie that will be used for persistence.

Note: This is required ONLY when Persistence Method is cookie_insert or cookie_passive.

The domain name of the server of a persistency cookie.

Note: This is required ONLY when Persistence Method is cookie_insert or cookie_passive.

The path property of the persistency cookie.

Note: This is required ONLY when Persistence Method is cookie_insert or cookie_passive.

The name of the header for which the value needs to be checked in the HTTP requests.

Note: This is required ONLY when Persistence Method is http_header.

The name of the parameter for which the value needs to be checked in the URL.

Note: This is required ONLY when Persistence Method is url_parameter.

The SSL status of the service. The values include:

• on
• off

The certificate that needs to be presented to the client accessing the service.

Note: This is required when SSL status is On.

SSL 3.0 protocol to be used by the clients to establish the connection to the service. The values include:

• yes
• no

TLS 1.0 protocol to be used by the clients to establish the connection to the service. The values include:

• yes
• no

TLS 1.1 protocol to be used by the clients to establish the connection to the service. The values include:

• yes
• no

TLS 1.2 protocol to be used by the clients to establish the connection to the service. The values include:

• yes
• no

The status of Server Name Indication (SNI). The values include:

• yes
• no

Specifies whether to block access to non-SNI clients or not.  The values include:

• yes
• no

The domain name for which the SNI check needs to be enforced. You can specify multiple domain names with comma (,) as a delimiter without any space.

Note:

• This is a required parameter when enable_sni is set to Yes.
• When domain is passed as a parameter in the API request, sni_certificate should be specified along with the domain. Also, optionally you can specify the ECDSA certificate by passing sni_ecdsa_certificate.

The certificate(s) to be associated with the specified domain(s) name.

This is a required parameter when enable_sni is set to Yes.

Specifies whether to create a new ephemeral public-private key pair for every SSL/TLS session. The Values include:

• yes
• no

Specifies the ciphers to be used for the service. The enumerated values include:

• default
• custom

For information on how to pass custom ciphers in a request, refer to the example given below ( see Example 2).

The cipher suits to be used when ciphers is set to custom. Use comma (,) as a separator to specify multiple cipher suits.

For information on how to pass custom ciphers in a request, refer to the example given below ( see Example 2).

The cipher suits to be used to override the default set of ciphers associated with the SSL.3.0 protocol.

Note:

• Use comma (,) as a separator to specify multiple cipher suits.
• This is applicable only when enable_ssl_3 is set to Yes.

For information on how to pass override ciphers in a request, refer to the example given below ( see Example 3).

The cipher suits to be used to override the default set of ciphers associated with the TLS.1.0 protocol.

Note:

• Use comma (,) as a separator to specify multiple cipher suits.
• This is applicable only when enable_tls_1 is set to Yes.

For information on how to pass override ciphers in a request, refer to the example given below ( see Example 3).

The cipher suits to be used to override the default set of ciphers associated with the TLS.1.1 protocol.

Note:

• Use comma (,) as a separator to specify multiple cipher suits.
• This is applicable only when enable_tls_1_1 is set to Yes.

For information on how to pass override ciphers in a request, refer to the example given below ( see Example 3).

Specifies whether to enable or disable client authentication for the service, or the content rules configured under the service. The enumerated values include:

• disable
• for_service
• for_selected_rule(s)

Determines if the clients are required to present their certificate when connecting to the service. The values include:

• yes
• no

Note:

• enforce_client_certificate should be set to yes when enable_client_authentication is set to for_service,
• enforce_client_certificate is enabled by default when enable_client_authentication is set to for_selected_rule(s).

The rules to which users must present their certificate when accessing the service.

Note: This is applicable only when enable_client_authentication is set to for_selected_rule(s).

The status of instant SSL policy. The values include:

• on
• off

Specifies whether to provide support for SharePoint rewrite or not. Sharepoint rewrite support is relevant only if an Instant SSL service is created to protect a Microsoft SharePoint application. The values include:

• on
• off

Specifies whether to enable or disable Web Application Firewall for this service. Note that Web Application Firewall globally manages network protection against attacks. By default, this is set to Yes. Select “no” if you want to temporarily disable Web Application Firewall without losing the configuration settings. The values include:

• yes
• no

Specifies whether or not the Barracuda Web Application Firewall prematurely closes the TCP connection, when it receives a 401 error code from the Server, during the NTLM authentication process. The values include:

• yes
• no