reservation (nrcmd)					reservation (nrcmd)


NAME
    reservation - Configures DHCP reservations

SYNOPSIS
    reservation [<vpn-name>/]<ipaddr> create (<macaddr>|<lookup-key>)
                       [-mac|--blob|-string] [attribute=<value>...]
    reservation [<vpn-name>/]<ipaddr> delete 
    reservation [<vpn-name>/]<ipaddr> get <attribute>
    reservation [<vpn-name>/]<ipaddr> show
    reservation list [[<vpn-name>/]<ipaddr>|-mac|-key]

DESCRIPTION
    The reservation command lets you manipulate Network Registrar's
    global list of reservations. Changes to reservations also modify
    the reservations listed with each scope (and vice versa). Thus,
    these commands are an alternative to the scope's addReservation,
    removeReservation, and listReservation commands.

    A matching scope must exist for each reservation in the global
    list. When you create or delete reservations, they are added or
    removed from the appropriate scope. When multiple scopes exist
    for the same subnet, you must specify the include-tags attribute
    to match the reservation to the appropriate scope. If no matching
    scope is found, the edit is rejected as invalid.

    The reservation list command displays the reservations in
    address order unless -mac or -key is specified to change the
    sort order.

EXAMPLES

STATUS

SEE ALSO

PROPERTIES
  Attributes:

    client-class[6] (AT_NAMEREF(ClientClass), Optional, default: <none>)
        Identifies the client-class to use when selecting from among
        scopes that might contain a specified reservation.

    description[11] (AT_STRING, Optional, default: <none>)
        Describes the device that this reservation object represents.

    device-name[10] (AT_STRING, Optional, default: <none>)
        Displays the name of the device represented by this
        reservation object.

    include-tags[4] (AT_NLIST(AT_STRING), Optional, default: <none>)
        Displays the selection criteria for this reservation.

    ip6address[12] (AT_IP6NET, Optional, default: <none>)
        Specifies the IPv6 address for the reservation.

    ipaddr[2] (AT_IPADDR, Optional, default: <none>)
        Displays an IP address within the network that the scope specifies
        and that contains the reservation.

    lookup-key[13] (AT_BLOB, Optional, default: <none>)
        Displays the  sequence of bytes which is the key for this reservation
        object.  If this attribute appears in the reservation object, its
        value overrides any value in the mac attribute.  The type of this
        object is found in the attribute lookup-key-type.

    mac[1] (AT_MACADDR, Optional, default: <none>)
        Displays the MAC address of the client for whom the specified
        IP address is to be reserved.

    relay-info[7] (AT_OPTION, Optional, default: <none>)
        Sets the contents of DHCP option-82 (relay-agent-info) to insert
        in a synthesized lease. For leasequery to work with reservations
        for static addresses in a cable environment, the relay-agent option
        information needs to be configured with the reservation.  If set,
        the attribute should contain all the contents of the relay-agent-info
        (option-82) to be provided in a synthesized leasequery response for
        this reservation.

    vpn-id[3] (AT_INT, Optional, default: 0)
        Displays the identifier of the VPN that contains this reservation.

