Fortinet black logo

CLI Reference

config load-balance real-server

config load-balance real-server

Use this command to configure real servers. Real servers are physical servers that are used to form real server pools. These dedicated servers provide clients with services such as HTTP or XML content, streaming audio or video, TFTP/FTP uploads and downloads, etc. You can start configuring a real server by giving it a unique configuration name, setting its status, and specifying its IP address.

After you have created your real server configuration objects, you can select them as members to form real server pools. At that stage, further configurations are needed as discussed in config load-balance pool.

Syntax

config load-balance real-server

edit <name>

set server-type {static|dynamic_manual}

set status {enable|disable|maintain}

set type {ip|fqdn|fqdn_populate_more}

set ip <ipv4-netmask>

set ip6 <ipv6-netmask>

set fqdn <string>

set auto_populate {enable|disable}

set auto_populate_from <string>

set sdn-connector <datasource>

set instance <string>

next

end

server-type

Select the real server type:

  • static

  • dynamic_manual

status

Select one of the options:

  • enable — The server can receive new sessions.
  • disable — The server does not receive new sessions and closes any current sessions as soon as possible.
  • maintain — The server does not receive new sessions but maintains any current connections.

type

The type option is available if the server-type is static.

Select the static server type to use for DNS resolution:

  • ip — Use the specified IPv4 Address or IPv6 Address.

  • fqdn — Use the specified FQDN of the Real Server for DNS resolution. The address will be resolved by the DNS query. Only one IPv4 or IPv6 address will be used to form the real server.

  • fqdn_populate_more — Use the specified FQDN of the Real Server for DNS resolution. The address will be resolved by the DNS query. Multiple IPv4 or IPv6 addresses will be used to form the real server. A maximum of 16 IPv4 or IPv6 addresses is supported for one domain.
    If the DNS query gets more than 1 IP or IPv6 address for the Real Server FQDN, then the system will automatically generate real servers based on the specified FQDN.
    Only select the fqdn_populate_more option when creating a new Real Server configuration. If an existing real server configuration set to ip or fqdn type is changed to fqdn_populate_more, the auto-population function will fail to populate pool members.

ip

The ip option is available if the server-type is static and the type is ip.

For IPv4 real server, enter the real server's IP address in IPv4 address format.

ip6

The ip6 option is available if the server-type is static and the type is ip.

For IPv6 real server, enter the real server's IP address in IPv6 address format.

fqdn

The fqdn option is available if the server-type is static and the type is fqdn or fqdn_populate_more.

Specify a fully qualified domain name, such as "www.example.com". This is required.

auto_populate

The auto_populate field appears if the server-type is static and the type is fqdn_populate_more.

  • disabled — By default, Auto Populate is disabled. This indicates that the current real server configuration is not auto-generated.

  • enabled — This indicates that the current real server configuration was automatically generated by the system based on the "parent" real server's FQDN. If the DNS query gets more than 1 IP or IPv6 address for the Real Server FQDN of the
    parent" real server, then the system will automatically populate real servers based on the specified FQDN, with the "child" real server name based on the "parent" real server name as specified in the auto_populate_from (read-only) field. The auto-generated real servers will be read-only and cannot be cloned or edited.

auto_populate_from

The auto_populate_from field is read-only and appears if the current real server was auto-generated by the system through FQDN Populate More function.

The auto-populate more field shows the Real Server name from which the auto-generated real servers will be based on.

The auto-generated real server names will appear in the following format:

Real Server Name_\d\d_random number

For example:

If the Real Server Name is "xxx", then the name of the auto-generated real server can be "xxx_01_69104274032".

sdn-connector

The sdn-connector is available if the server-type is dynamic_manual.

Specify a previously configured SDN Connector.

instance

The instance is available if the server-type is dynamic_manual.

Specify the instance of your SDN Connector.

Examples

Static Server IP

config load-balance real-server

edit "static_ip"

set server-type static

set status enable

set type ip

set ip 0.0.0.0

set ip6 ::

next

end

Static Server FQDN

config load-balance real-server

edit "static_fqdn"

set server-type static

set status enable

set type fqdn

set fqdn www.example.com

next

end

Static Server FQDN Populate More

config load-balance real-server

edit "static_auto"

set server-type static

set status enable

set type fqdn_populate_more

set fqdn rs1.fortiadc.com

next

end

FortiADC (root) # show load-balance real-server

config load-balance real-server

edit "static_auto_01_65874123657"

set server-type static

set type fqdn_populate_more

set fqdn rs1.fortiadc.com

set auto_populate enable

set auto_populate_from static_auto

next

end

Dynamic Manual Server

config load-balance real-server

edit dynamic_manual

set server-type dynamic_manual

set status enable

set sdn-connector aws_connector

set instance aws_fadc

next

end

config load-balance real-server

Use this command to configure real servers. Real servers are physical servers that are used to form real server pools. These dedicated servers provide clients with services such as HTTP or XML content, streaming audio or video, TFTP/FTP uploads and downloads, etc. You can start configuring a real server by giving it a unique configuration name, setting its status, and specifying its IP address.

After you have created your real server configuration objects, you can select them as members to form real server pools. At that stage, further configurations are needed as discussed in config load-balance pool.

Syntax

config load-balance real-server

edit <name>

set server-type {static|dynamic_manual}

set status {enable|disable|maintain}

set type {ip|fqdn|fqdn_populate_more}

set ip <ipv4-netmask>

set ip6 <ipv6-netmask>

set fqdn <string>

set auto_populate {enable|disable}

set auto_populate_from <string>

set sdn-connector <datasource>

set instance <string>

next

end

server-type

Select the real server type:

  • static

  • dynamic_manual

status

Select one of the options:

  • enable — The server can receive new sessions.
  • disable — The server does not receive new sessions and closes any current sessions as soon as possible.
  • maintain — The server does not receive new sessions but maintains any current connections.

type

The type option is available if the server-type is static.

Select the static server type to use for DNS resolution:

  • ip — Use the specified IPv4 Address or IPv6 Address.

  • fqdn — Use the specified FQDN of the Real Server for DNS resolution. The address will be resolved by the DNS query. Only one IPv4 or IPv6 address will be used to form the real server.

  • fqdn_populate_more — Use the specified FQDN of the Real Server for DNS resolution. The address will be resolved by the DNS query. Multiple IPv4 or IPv6 addresses will be used to form the real server. A maximum of 16 IPv4 or IPv6 addresses is supported for one domain.
    If the DNS query gets more than 1 IP or IPv6 address for the Real Server FQDN, then the system will automatically generate real servers based on the specified FQDN.
    Only select the fqdn_populate_more option when creating a new Real Server configuration. If an existing real server configuration set to ip or fqdn type is changed to fqdn_populate_more, the auto-population function will fail to populate pool members.

ip

The ip option is available if the server-type is static and the type is ip.

For IPv4 real server, enter the real server's IP address in IPv4 address format.

ip6

The ip6 option is available if the server-type is static and the type is ip.

For IPv6 real server, enter the real server's IP address in IPv6 address format.

fqdn

The fqdn option is available if the server-type is static and the type is fqdn or fqdn_populate_more.

Specify a fully qualified domain name, such as "www.example.com". This is required.

auto_populate

The auto_populate field appears if the server-type is static and the type is fqdn_populate_more.

  • disabled — By default, Auto Populate is disabled. This indicates that the current real server configuration is not auto-generated.

  • enabled — This indicates that the current real server configuration was automatically generated by the system based on the "parent" real server's FQDN. If the DNS query gets more than 1 IP or IPv6 address for the Real Server FQDN of the
    parent" real server, then the system will automatically populate real servers based on the specified FQDN, with the "child" real server name based on the "parent" real server name as specified in the auto_populate_from (read-only) field. The auto-generated real servers will be read-only and cannot be cloned or edited.

auto_populate_from

The auto_populate_from field is read-only and appears if the current real server was auto-generated by the system through FQDN Populate More function.

The auto-populate more field shows the Real Server name from which the auto-generated real servers will be based on.

The auto-generated real server names will appear in the following format:

Real Server Name_\d\d_random number

For example:

If the Real Server Name is "xxx", then the name of the auto-generated real server can be "xxx_01_69104274032".

sdn-connector

The sdn-connector is available if the server-type is dynamic_manual.

Specify a previously configured SDN Connector.

instance

The instance is available if the server-type is dynamic_manual.

Specify the instance of your SDN Connector.

Examples

Static Server IP

config load-balance real-server

edit "static_ip"

set server-type static

set status enable

set type ip

set ip 0.0.0.0

set ip6 ::

next

end

Static Server FQDN

config load-balance real-server

edit "static_fqdn"

set server-type static

set status enable

set type fqdn

set fqdn www.example.com

next

end

Static Server FQDN Populate More

config load-balance real-server

edit "static_auto"

set server-type static

set status enable

set type fqdn_populate_more

set fqdn rs1.fortiadc.com

next

end

FortiADC (root) # show load-balance real-server

config load-balance real-server

edit "static_auto_01_65874123657"

set server-type static

set type fqdn_populate_more

set fqdn rs1.fortiadc.com

set auto_populate enable

set auto_populate_from static_auto

next

end

Dynamic Manual Server

config load-balance real-server

edit dynamic_manual

set server-type dynamic_manual

set status enable

set sdn-connector aws_connector

set instance aws_fadc

next

end