prefix-template (nrcmd)				  prefix-template (nrcmd)


NAME
    prefix-template - Configures a prefix template.

SYNOPSIS
    prefix-template <name> create [<attribute>=<value> ...]
    prefix-template <name> delete
    prefix-template <name> set <attribute>=<value> [<attribute>=<value> ...]
    prefix-template <name> get <attribute>
    prefix-template <name> unset <attribute>

    prefix-template <name> disable <attribute>
    prefix-template <name> enable <attribute>
    prefix-template <name> show

    prefix-template <name> create clone=<clone-name>
    prefix-template <name> apply-to all | <prefix1>[,...]>

DESCRIPTION
    The prefix-template command lets you configure a template to use
    when creating prefixes.

EXAMPLES

STATUS

SEE ALSO
    prefix

PROPERTIES
  Attributes:

    allocation-algorithms[15] (AT_FLAGSINT(), Optional, default: reservation,extension,random,best-fit)
        Controls the algorithms used by the server to select a new address
        or prefix to lease to a client. The available algorithms are:
          client-request
            This setting (off by default) controls whether the server
            uses a client requested lease.
          reservation
            This setting (on by default) controls whether the server
            uses an available reservation for the client.
          extension
            This setting (on by default) controls whether the server calls
            extensions attached at the generate-lease extension point
            to generate an address or prefix for the client.
          interface-identifier
            This setting (off by default) controls whether the server uses
            the interface-identifier from the client's (link-local)
            address to generate an address. It is ignored for temporary
            addresses and prefix delegation.
          random
            This setting (on by default) controls whether the server
            generates an address using an RFC 3041-like algorithm. It is
            is ignored for prefix delegation.
          best-fit
            This setting (on by default) controls whether the server will
            delegate the first, best-fit available prefix. It is ignored
            for addresses.
        When the server needs an address to assign to a client, it
        processes the flags in the following order: client-request,
        reservation, extension, interface-identifier, and random.
        Processing stops when a usable address is produced.
        When the server needs to delegate a prefix to a client, it
        processes the flags in the following order: client-request,
        reservation, extension, best-fit. Processing stops when a
        usable prefix is produced.

    deactivated[14] (AT_BOOL, Optional, default: disabled)
        Controls whether a prefix extends leases to clients. A deactivated
        prefix does not extend leases to any clients. It treats all addresses
        in its ranges as if they were individually deactivated.
        Default, false (active).

    description[19] (AT_STRING, Optional, default: <none>)
        Describes the prefix template.

    dhcp-type[4] (AT_ENUMINT(), Optional, default: dhcp)
        Defines how DHCP manages address assignment within a prefix:
          stateless         Prefix is used only for stateless
                            option configuration.
          dhcp              Prefix is used for stateful address
                            assignment.
          prefix-delegation Prefix is used for prefix-delegation.
          infrastructure    Prefix is used to map a client address to
                            a link, and does not have an address pool.
          parent            Prefix is not used by DHCP. It is used as
                            a container object, to group child prefixes.

    expiration-time[11] (AT_DATE, Optional, default: <none>)
        Sets the time and date on which a prefix expires. After this date
        and time, the server neither grants new leases nor renews existing
        leases from this prefix.
        Once the expiration-time has passed, the prefix is no longer used
        (though old leases and leases with grace or affinity periods
        continue to exist until those periods elapse).
        Enter this as a date in the format  "[weekday] mon day
        hh:mm[:ss] year". For example, "Dec 31 23:59 2006".

    free-address-config[22] (AT_NAMEREF(AddrTrapConfig), Optional, default: <none>)
        Identifies which trap captures unexpected free address events
        on this prefix.
        If this attribute is not configured, the server looks for
        the free-address-config attribute on the parent Link object.
        If that attribute is not configured, the server looks for
        the v6-default-free-address-config on the DHCPServer object.

    ignore-declines[13] (AT_BOOL, Optional, default: false)
        Controls whether the DHCP server responds to a DHCPv6 DECLINE
        message that refers to an IPv6 address or a delegated prefix
        from this prefix.
        If enabled, the DHCP server ignores all declines for leases
        in this prefix.
        If disabled or not set, the DHCP server sets to UNAVAILABLE
        every address or delegated prefix requested in a DECLINE
        message if it is leased to the client.
        The default value is false, so that DECLINE messages are
        processed normally.

    max-leases[21] (AT_RANGEINT(0-2000000), Optional, default: 65536)
        Sets the maximum number of non-reserved leases that the server
        will allow to exist on the prefix. When a new lease needs to
        be created, the server will only do so if the limit has not
        been exceeded. When the limit is exceeded, no new leases can be
        created and offered to clients.

    name[1] (AT_STRING, Required, default: <none>)
        Assigns a name to this prefix template.

    options-expr[7] (AT_EXPR, Optional, default: <none>)
        Defines an expression that evaluates to the list of
        embedded policy options to be created.

    policy[6] (AT_NAMEREF(Policy), Optional, default: <none>)
        Refers to a shared policy to use when replying to clients.

    prefix-description-expr[18] (AT_EXPR, Optional, default: <none>)
        Defines an AT_STRING expression to apply to the description
        on the prefix object created when using the template.

    prefix-name-expr[2] (AT_EXPR, Optional, default: <none>)
        Defines an expression that evaluates to an AT_STRING value
        to use for the name of the prefix object created when using
        the template.

    range-expr[5] (AT_EXPR, Optional, default: <none>)
        Defines an expression that evaluates to an AT_PREFIX value
        for the prefix range to be created.

    reverse-zone-prefix-length[20] (AT_RANGEINT(0-124), Optional, default: <none>)
        Identifies the prefix length of the reverse zone for ip6.arpa
        updates. The server forms the zone name using this value if
        configured; otherwise the prefix length is determined from the
        Prefix. This value must be a multiple of 4 as ip6.arpa zones are
        on 4 bit (nibble) boundaries. If not a multiple of 4, it is
        rounded up to the next higher multiple of 4.

    selection-tags[3] (AT_NLIST(AT_STRING), Optional, default: <none>)
        Associates selection tags with an IPv6 prefix.

