prefix (nrcmd)			                       prefix (nrcmd)


NAME
    prefix - Configures IPv6 network prefixes for use in DHCPv6

    Note: dhcp-prefix is a synonym for compatibility with earlier
    versions of Network Registrar.

SYNOPSIS
    prefix list  
    prefix listnames
    prefix <name> create <address> [template=<template-name>]
                         [<attribute>=<value>] 
    prefix <name> delete
    prefix <name> set <attribute>=<value> [<attribute>=<value> ...]
    prefix <name> get <attribute>
    prefix <name> unset <attribute>
    prefix <name> enable <attribute>
    prefix <name> disable <attribute>
    prefix <name> [show]

    prefix <name> listLeases

    prefix <name> addReservation <address> <lookup key>
    prefix <name> removeReservation <address>
    prefix <name> listReservations
    
    prefix <name> applyTemplate <template-name>

DESCRIPTION
    The prefix command configures IPv6 network prefixes. Prefixes
    configure DHCPv6 address allocation and prefix delegation.

    When creating a prefix using a template, specify - for the
    <name> to allow the prefix template's prefix-name-expr to
    name the prefix.

EXAMPLES
    nrcmd> prefix example-pref create ff00::/8 
    nrcmd> prefix example-pref set address=ff00::/10 


STATUS

SEE ALSO
    link, prefix-template

PROPERTIES
  Attributes:

    address[2] (AT_PREFIX, Required, default: <none>)
        Identifies a prefix (subnet) that an interface belongs to using the
        high-order bits of an IPv6 address.

    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[18] (AT_STRING, Optional, default: <none>)
        Describes the prefix.

    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.

    embedded-policy[7] (AT_OBJ, Optional, default: <none>)
        Specifies a policy embedded within an IPv6 prefix.

    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.

    link[9] (AT_NAMEREF(Link), Optional, default: <none>)
        Associates an IPv6 prefix (subnet) with a link. Use this attribute
        to group prefixes that are on a single link.

    local-cluster[19] (AT_OID, Optional, default: <none>)
        Identifies the local DHCP cluster or failover pair
        for this regional prefix.

    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 this 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.
        This limit is not applied when existing leases are loaded from
        the lease state database during server start-up.
        This attribute is also used when calculating the free-address
        level for address traps.

    name[1] (AT_STRING, Required, default: <none>)
        Assigns a name to an IPv6 prefix (subnet).

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

    range[5] (AT_PREFIX, Optional, default: <none>)
        Specifies a subrange the server can use to configure prefixes
        for address assignment.
        The prefix used depends on the value set for the dhcp-type attribute.
        If not set, the prefix address is used. This may specify a longer
        prefix than the prefix address to limit the range of addresses
        or prefixes available for assignment.

    reverse-zone-prefix-length[20] (AT_RANGEINT(0-124), Optional, default: <none>)
        Specifies the prefix length of the reverse zone for ip6.arpa
        updates. You do not need to specify the full reverse zone, 
        because you can synthesize it by using the ip6.arpa domain. 
            Use a multiple of 4 for the value, because ip6.arpa zones 
            are on 4-bit boundaries. If not a multiple of 4, the value
            is rounded up to the next multiple of 4. 
            The maximum value is 124, because specifying 128 would 
            create a zone name without any possible hostnames 
            contained within. 
            A value of 0 means none of the bits are used for the zone 
            name, hence ip6.arpa is used. 
            If you omit the value from the DNS update configuration, 
            the server uses the value from the prefix or, as a last 
            resort, the prefix length derived from the address value
            of the prefix.

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

    vpn-id[8] (AT_INT, Optional, default: 0)
        Identifies the VPN that contains an IPv6 prefix.

