aboutsummaryrefslogtreecommitdiff
path: root/nixpkgs/nixos/modules/services/networking/keepalived/virtual-ip-options.nix
{ lib } :

with lib;
{
  options = {

    addr = mkOption {
      type = types.str;
      description = ''
        IP address, optionally with a netmask: IPADDR[/MASK]
      '';
    };

    brd = mkOption {
      type = types.nullOr types.str;
      default = null;
      description = ''
        The broadcast address on the interface.
      '';
    };

    dev = mkOption {
      type = types.nullOr types.str;
      default = null;
      description = ''
        The name of the device to add the address to.
      '';
    };

    scope = mkOption {
      type = types.nullOr types.str;
      default = null;
      description = ''
        The scope of the area where this address is valid.
      '';
    };

    label = mkOption {
      type = types.nullOr types.str;
      default = null;
      description = ''
        Each address may be tagged with a label string. In order to preserve
        compatibility with Linux-2.0 net aliases, this string must coincide with
        the name of the device or must be prefixed with the device name followed
        by colon.
      '';
    };

  };
}