report (nrcmd)                                      report (nrcmd)


NAME
    report - Creates a summary report of address usage

SYNOPSIS
    report [column-separator=<string>]
           [dhcp-only]
           [dhcpv4]
           [dhcpv6]
           [file=<output file>]
           [vpn=<vpn-name>] 

DESCRIPTION
    The report command provides address utilization reporting 
    for all subnets containing addresses that are handled by the
    DHCP server. The DHCP server must be running to obtain
    the report or a "Connection Failure" error message 
    will be returned.

    The report command provides v4 and v6 utilization.  The option
    'dhcp-only' will be kept as a synonym for 'dhcpv4', to provide
    backwards compatibility.

    The output for the report dhcpv4 command is a table consisting of 
    column-aligned data for each defined scope, subnet, and
    CCM address block. Subtotals are listed for subnets and address
    blocks that contain multiple scopes or subnets. A grand total row  
    summarizes the data from all the subnets.
     
    Each row lists the following information:

    o  Subnet/Mask
    o  Scope Name 
    o  %Free - percentage of dynamic addresses available to be leased 
    o  Total Dynamic - total number of addresses configured,   
       excluding reservations
    o  Total Reserved - total reserved addresses
    o  Leased - addresses actively leased by clients
    o  Avail - addresses available to be leased
    o  Other Avail - addresses set aside to be leased by this server's
       failover partner
    o  Pending Avail - leases not available to be leased because the
       server is in the communications-interrupted failover state.
    o  In Transition - leases offered to clients or waiting for the 
       configured grace period before again becoming available 
    o  Reserved Active - reserved addresses actively leased by clients
    o  Unavail - addresses marked unavailable 
    o  Active Deactivated - addresses that have been administratively
       deactivated
          

    The output for the report dhcpv6 command is a table consisting of 
    column-aligned data for each defined prefix.  If requested, totals 
    will be computed for each parent prefix defined in the address tree. 
    Separate total lines will be shown for child prefixes classified 
    for prefix delegation or dhcp allocation. No counters apply for 
    stateless configuration or infrstructure entries. The only attribute
    that may be reported is whether the prefix has been deactivated.
    Total lines will be skipped if the prefix-count for a given type 
    is 0.
     
    Each row lists the following information:

    o  Prefix/Mask
    o  Prefix Name 
    o  Total Reserved - total number of reserved leases configured 
       in this prefix
    o  Leased - addresses actively leased by clients
    o  Revoked - dynamic leases (leases that are not reserved) that 
       are no longer usable by the client, but that may still be in use
    o  In Transition - leases offered to clients or waiting for the 
       configured grace period before again becoming available 
    o  Reserved Active - reserved addresses actively leased by clients
    o  Reserved Inactive - reserved addresses not used by their assigned 
       DHCP clients
    o  Reserved Unavail -  reserved addresses marked unavailable
    o  Unavail - addresses marked unavailable 
    o  Active Dynamic - total number of dynamic leases actively in 
       use
    o  Active Deactivated - number of dynamic and reserved leases
       currently leased by DHCP clients, but have also been 
       administratively deactivated 
    o  Deactivated -  addresses that have been administratively
       deactivated
          
EXAMPLES

   report 
   report file=myreport.txt 

STATUS

SEE ALSO
    export addresses, lease-notification, session current-vpn

PROPERTIES

REPORT KEYWORDS

    column-separator
        Specifies the character string you want used between the
        columns in the report. The default is a single space. If
        you specify more than one space, you must use a backslash
        (\) to allow the extra spaces, and if you enter the spaces
        on the command line, use quotation marks.

    dhcp-only
        Provided for command-syntax compatibility with prior versions,
        specifies a summary of the DHCP server information. 
        This is the only option available for the report command, 
        and is no longer required to run the command.

    dhcpv4
        Displays ipv4 utilization.

    dhcpv6
        Display ipv6 utilization.

    file
        Specifies the filename to which the report command writes
        the output. If you do not specify a filename, the report
        command writes to 'standard out'.

    vpn
        The VPN address space from which to select scopes to examine 
        when executing this command. If no vpn-name is specified,
        then the session's current-vpn is used. If the reserved
        vpn-name "global" is used, then the global (or unnamed)
        VPN address space is used. The reserved vpn-name "all" is not
        allowed for this command, because the report command has no
        mechanism to distinguish identical IP addresses in different
        VPNs.

