lease6 (nrcmd)							lease6 (nrcmd)


NAME
    lease6 - Manage DHCP lease6 objects

SYNOPSIS
    lease6 list [-duid=<client-id>]
                [-lookup-key=<lookup-key> [-blob|-string]]
                [-macaddr=<mac-addr>] [-cm-macaddr=<mac-addr>]
                [-vpn=<vpn-name>] [-count-only]
    lease6 [<vpn-name>/]<ipv6-address> [show]
    lease6 [<vpn-name>/]<ipv6-address> get <attribute>
    lease6 [<vpn-name>/]<ipv6-address> activate 
    lease6 [<vpn-name>/]<ipv6-address> deactivate
    lease6 [<vpn-name>/]<ipv6-address> force-available
    lease6 [<vpn-name>/]<ipv6-address> reconfigure
                   [renew|rebind|information-request] [-unicast|-via-relay]

DESCRIPTION
    The lease6 command lets you view and manipulate the current DHCPv6
    leases in the cluster.  
    
    When you specify the lease on which one of these commands is to
    operate, you may optionally specify a <vpn-name> in which the
    <ipv6-address> is to be found.  Specify the name of a currently
    defined vpn as the <vpn-name>; or use the reserved vpn name
    "global" (without the quotation marks) to specify the operation
    on leases which are not in any explicitly defined VPN.  If you do not
    specify a vpn-name, the current VPN of the session is used.
    
    lease6 list [-duid=<client-id>]
                [-lookup-key=<lookup-key> [-blob|-string]]
                [-macaddr=<mac-addr>] [-cm-macaddr=<mac-addr>]
                [-vpn=<vpn-name>] [-count-only]
       The list command lists DHCPv6 leases in the DHCP server. Only
       the leases in the current VPN or specified vpn-name are listed.
       The vpn-name may be "all" (without the quotation marks) to 
       request leases in all VPNs. If -count-only is specified, only 
       the count of the number of leases is returned (no leases are 
       displayed). If a filter (-duid, -lookup-key, -macaddr, or 
       -cm-macaddr) is specified, only the leases matching the filter
       are displayed.

    lease6 [<vpn-name>/]<ipv6-address> activate 
    lease6 [<vpn-name>/]<ipv6-address> deactivate   
       The activate and deactivate commands tell the DHCP server to make
       the specified lease active or inactive. An inactive lease is not 
       given out, even if it is in the available state.  Making a currently 
       leased lease inactive will not affect its behavior until it has 
       expired and become available again.
    
    lease6 [<vpn-name>/]<ipv6-address> force-available    
       The force-available command forces the specified lease into the 
       available state.

    lease6 [<vpn-name>/]<ipv6-address> reconfigure
       The reconfigure command initiates sending the client a Reconfigure
       message (if the client and server negotiated to allow reconfigure).

EXAMPLES

STATUS

SEE ALSO
    session 

PROPERTIES
  Attributes:

    binding-end-time[25] (AT_DATE, Optional, default: <none>)
        Within the lease database, this holds the time when a lease binding
        ended.

    binding-iaid[12] (AT_INT, Optional, default: <none>)
        The IAID of the binding.

    binding-rebinding-time[18] (AT_DATE, Optional, default: <none>)
        Displays the earliest time when the server requested the client
        to issue a Rebind request for the binding.

    binding-renewal-time[17] (AT_DATE, Optional, default: <none>)
        Displays the earliest time when the server requested the client
        to issue a Renew request for the binding.

    binding-start-time[24] (AT_DATE, Optional, default: <none>)
        Within the lease database, holds the time when a lease binding
        began.

    binding-type[11] (AT_ENUMINT(), Optional, default: <none>)
        Specifies the type of binding for the lease. The type number matches
        the DHCPv6 option number.

    client-active-leases[26] (AT_INT, Optional, default: <none>)
        Shows the number of active leases that a client currently
        has in use.

    client-class-name[7] (AT_NAMEREF(0), Optional, default: <none>)
        Displays the most recently derived class name for the client.

    client-id[4] (AT_BLOB, Optional, default: <none>)
        Displays the DUID of the client for the lease.

    client-last-transaction-time[6] (AT_DATE, Optional, default: <none>)
        Displays the time of last client transaction related to this lease.

    client-lookup-key[31] (AT_BLOB, Optional, default: <none>)
        Provides the lookup key for the client - it is either the client
        identifier (DUID) or the v6-override-client-id expression.

    client-reconfigure-key[36] (AT_BLOB, Optional, default: <none>)
        The 128-bit key required for Reconfigure Messages to the client
        per the RFC 3315 Reconfigure Key Authentication Protocol.

    client-reconfigure-key-generation-time[37] (AT_DATE, Optional, default: <none>)
        The time at which the client-reconfigure-key was generated.

    client-relay-address[33] (AT_IP6ADDR, Optional, default: <none>)
        If present, displays the source address from the most recently
        received Relay-Forw message. If not present, the client communicated
        directly to the server.

    client-relay-message[9] (AT_MSG6, Optional, default: <none>)
        Displays the most recently received relayed message. This data
        includes the complete Relay-Forw message(s) but excludes the client's
        message.

    client-user-defined-data[34] (AT_STRING, Optional, default: <none>)
        Enables customer applications to relate the client record to other
        databases.  It is not used directly by the DHCP server, but may be
        read and written by extensions and expressions.

    client-vendor-class[8] (AT_NLIST(AT_OPTION6), Optional, default: <none>)
        Displays the most recently received client vendor class data. Each
        group of data bytes starts with the 4-byte enterprise-number
        followed by the vendor-class-data bytes (if any).

    client-vendor-info[35] (AT_NLIST(AT_OPTION6), Optional, default: <none>)
        The most recently received vendor-specific information
        options data from the client. Each group of data bytes
        starts with the 4-byte enterprise-number followed by the
        option-data bytes (if any).

    creation-time[13] (AT_DATE, Optional, default: <none>)
        Sets the time when the lease was created.

    dns-update-flags[40] (AT_FLAGSINT(), Optional, default: <none>)
        The dns update flags maintained for the lease / fqdn binding.

    flags[21] (AT_FLAGSINT(), Optional, default: <none>)
        Flags for the lease:
            1  reserved
        	   The lease is reserved for some client DUID.  The table
               that relates DUID addresses to leases is in the prefix.
            3  deactivated
        	   The lease is deactivated, which means that it should not
               be used.  Any client which is using a deactivated lease
               will be told to stop using that address on the next
               renewal.
        For internal use only:
            initialized
            valid
            not_in_range

    forward-dnsupdate[41] (AT_NAMEREF(DnsUpdateConfig), Optional, default: <none>)
        Names the forward zone's DNS Update Configuration object
        for the lease.

    fqdn[39] (AT_DNSNAME, Optional, default: <none>)
        The fully qualified domain name assigned to the lease by the
        server (and possibly successfully entered into DNS).

    fqdn-host-label-count[43] (AT_INT, Optional, default: 1)
        The number of labels in the fqdn that constitute the
        host name portion.

    ip6address[1] (AT_IP6NET, Optional, default: <none>)
        Specifies the IPv6 address, or its prefix, of the lease.

    name-number[44] (AT_INT, Optional, default: <none>)
        The numeric characters in the fqdn, if any, that were added
        by the DHCP server to disambiguate the host name.

    preferred-lifetime[16] (AT_DATE, Optional, default: <none>)
        Sets the time at which the address or prefix that was last
        communicated to the client is no longer preferred.

    prefix-name[2] (AT_NAMEREF(Prefix), Optional, default: <none>)
        Identifies the prefix that contains this lease.

    requested-fqdn[38] (AT_ROF_FQDN, Optional, default: <none>)
        The partial or fully qualified domain name most recently
        requested by the client for the lease.

    reservation-lookup-key[29] (AT_BLOB, Optional, default: <none>)
        Retrieves the lookup key of a lease reservation,

    reverse-dnsupdate[42] (AT_NAMEREF(DnsUpdateConfig), Optional, default: <none>)
        Names the reverse zone's DNS update configuration object
        for the lease.

    start-time-of-state[14] (AT_DATE, Optional, default: <none>)
        Sets the time when the state last changed to its current value.

    state[20] (AT_ENUMINT(), Optional, default: <none>)
        Displays the current state of the lease:
            1  available
        	   The lease is not currently leased by the client.
            2  offered
        	   The lease is offered to the client.
        	   In many cases, the database is not written with
        	   information concerning offering a lease to a client
        	   since there is no requirement to update stable
        	   storage with this information.
            3  leased
        	   The lease is currently leased to the client.
            4  expired
        	   The client has not renewed the lease, and it expired and
               will be made available after the grace period expires.
            5  unavailable
        	   The lease is unavailable.  It was made unavailable because
               of some conflict.
            6  released
        	   The client has released the lease, but the server was
               configured to apply a grace period to the lease.  The
               lease won't be made available until the grace period
               expires.
            10 revoked
        	   The lease is no longer usable by the client, but the
               client may still be using it.

    state-expiration-time[19] (AT_DATE, Optional, default: <none>)
        Determines the earliest time at which the current state is to expire,
        resulting in a state transition. Possible transitions are:
             OFFERED to deleted (if not reserved)
             LEASED to EXPIRED
             EXPIRED to AVAILABLE
             RELEASED to AVAILABLE
             AVAILABLE to deleted (if not reserved)

    valid-lifetime[15] (AT_DATE, Optional, default: <none>)
        Sets the time at which the address or prefix that was last
        communicated to the client is no longer valid.

    vpn-id[3] (AT_INT, Optional, default: 0)
        Identifies the DHCP VPN that contains this lease.


